kitware / kw-doc Goto Github PK

Is there a way to set options for the markdown processor that kw-doc uses? I would like at least some of the markdown pages to respect the usual convention that linebreaks in the input do not create linebreaks in the output (but an empty line in the input will start a new paragraph).

I see that some pages that use kw-doc include some options at the top of the markdown (followed by a line with only --- to separate them from the start of the markdown). Is there any documentation for what options kw-doc accepts?

There does not appear to be any documentation and the example is very minimal.

• What is the relationship between data/menu.yml, tpl/__en__, and tpl/__sidebar__?
• How are banners or other background elements created in the main index.jade file?
• How would blog or other posts get added? I see build-tmp/public/2016/04/28/kw-doc/index.html and build-tmp/public/news/2016/04/index.html files are created, but not where content should go if we want it added.
• Was the kw-doc theme taken from a hexo theme? If so, was that theme documented? Does its documentation answer any of the above?

kw-doc does not appear to support github custom domain pages. I'm able to run the kw-doc script but setting the base url to "/"... and running kw-doc -s on my laptop causes problems. For instance, with this config.js:

module.exports = {
 baseUrl: '',
 work: './build-tmp',
 config: {
   title: 'project',
   description: '"Scalable stuff."',
   subtitle: '"Lightweight, zero-copy stuff."',
   author: 'the dude',
   timezone: 'UTC',
   url: 'https://thedude.github.io/',
   root: '/',
   github: 'thedude/project',
 }
};

it still tries to redirect localhost:4000/ to localhost:4000/project .

1. A good starting point is https://github.com/vibraphone/kwdoc-experiment.git . The difference between the master and custom-domain branches shows what I changed to make the document root be "/".

2. On the custom-domain branch, running "npm run doc:www"
   a. redirects http://localhost:4000/ to http://localhost:4000/kwdoc-experiment/
   b. properly displays http://localhost:4000/index.html
   c. makes the logo at the top-left of the page(2b) link to "/kwdoc-experiment" which is wrong.
   d. Serving the static content with "python -m SimpleHTTPServer" works except for the bad link in 2(c), so 2(a) is a hexo config issue.

Is there a way to override the logo text? In the generated HTML, the logo appears like so:

    <h1 id="logo-wrap">
      <a href="/sensei/" id="logo">ParaViewWeb</a>
    </h1>

but my project name is not ParaViewWeb.