appbaseio / docbase Goto Github PK

It's no longer possible to get the binary of phantom-js v0.7.2. It should be upgraded to 2.x+ in grunt-docbase project.

Use Application Cache to support offline documentation the first time user goes to the documentation:

https://www.w3schools.com/html/html5_app_cache.asp

The code snippet below is responsible for showing the active section in the sidebar during a doc navigation. It's present in the SPA mode, but when grunt converts the page to html mode. We need to execute the following script on each page for highlighting to work:

var $window = $(window);
    var $document = $(document);
    $document.on('ready', function() {
      $("h2, h3").scrollagent(function(cid, pid, currentElement, previousElement) {
        if (pid) {
         $("[pref='#"+pid+"']").removeClass('active');
        }
        if (cid) {
          $("[pref='#"+cid+"']").addClass('active');
        }
      });
    });

It's originally present in the flatdoc's theme file, but we miss adding the JS while converting to html mode - https://github.com/appbaseio/Docs/blob/master/bower_components/flatdoc/theme-white/script.js#L9

Currently, docbase imports Source sans pro font as default inside the css file. This makes it difficult to change the font.

Moving this to index.html solves the problem.

I want to develop locally before deploying to github. However, I'm getting error while trying to set it up.

1. I did yo docbase to generate the project locally.
2. npm install to install dependencies.
3. Did npm install -g grunt-cli and npm install -g bower as stated in docs.
4. Run grunt

However, I'm getting the following error.

Loading "GruntFile.js" tasks...ERROR
>> TypeError: First argument must be a string, Buffer, ArrayBuffer, Array, or array-like object.
Warning: Task "default" not found. Use --force to continue.

Aborted due to warnings.

When I perform the following steps I get an error in the console and a blank page is displayed when I hit the local site. Can't figure out if this is an issue with the product or not.

*) yo docbase
*) when prompted
*) For hosted option select 'Magic'
*) For publish option select 'Locally'
*) For color option select 'green'

...stuff is printed to console

Running "docbase:def" (docbase) task
starting
Erro generating page: build_html/index.html

Currently, code blocks get wrapped. It would be nice to add a scroll to the code blocks instead.

Full read view should be occupied when in mobile view.

When in literate mode, aka 3-columns - image width overflows the text area width.

Issues:

• Font family should be of type mono
• Use better color contrasts

How hard would it be to add a basic authentication layer? (ie: for documenting private git-hub projects on a GitHub pages site)

I realise the published documentation content/back-end files could still be accessed by an unauthenticated user by guessing their URLs, but a simple authentication mechanism on the front-end SPA would be sufficiently-secure for many private projects.

Ideally, authentication linked to GitHub would be awesome if it allowed access to the published documentation based on a user's permission to access the underlying documentation's GitHub repo.

(This is something I would be interested in contributing to, since most documentation systems are focused on public vs private documentation, and I'm still looking for a GitHub-centric alternative for documenting our team's private projects. )

Regards, Michael

• remove margin-right from strong title
• apply padding only for code immediate after strong
• first element p tag -> strong : make it title
• remove style.css from generator
• Strong title color changes to #999

I want to set up a completely custom html page as a front page. I set indexHtml in docbaseConfig as ./html/custompage.html.

It is working fine in local machine. The front page is custom and the docs are in the default layout. However, when I push the changes, it timeout in travis ci.

No output has been received in the last 10m0s, this potentially indicates a stalled build or something wrong with the build itself.
Check the details on how to adjust your build configuration on: https://docs.travis-ci.com/user/common-build-problems/#Build-times-out-because-no-output-was-received
The build has been terminated

After going through grunt-docbase code, I added a #navbar-collapse and .map_folder for checkLoadedSelector and checkNavbar checks.

I also tried setting manual_override to true.

What am I missing. What is the correct way to set a custom front page?

This should simplify the installation procedure.

TBD. The idea is to use more contrast oriented style rather than using borders everywhere.

Would you consider supporting html in addition to markdown? This would make it easy to convert (or scrape) existing documentation sites for publishing using docbase.