alljoyn/extras-webdocs

webdocs

Project contains content for AllSeen Alliance developer website.

Organization

• docs/ - contains source of docs.
• doctools/ - contains support files for creating markdown documents (cheatsheet and document template)
• templates/ - templates used to generate HTML
• scripts/ - scripts to generate HTML and to host server
• files/ - other (non markdown) files, like images
• source/ - source for files in files/ like svg image file
• out/public/ - generated HTML files.
• out/for_import/ - generated HTML for Drupal import (usually not needed)

How to use the doctools

For more information on how to use the doctools, check the readme file inside the doctools folder.

How to run scripts

node.js and npm is required. Install from from an installer or from a package manager.

Install node modules:

cd scripts
npm install
cd ..

Runs this to generate the HTML files in out/public/:

node scripts/generate_docs.js

Note that the node program may be called nodejs on some platforms, like Linux.

Or, run in watch mode to wait (forever) for changes in docs/files to generate the HTML files.

node scripts/generate_docs.js watch

Run this to check the generated file for orphan documents and orphan links:

node scripts/linkchecker.js

Run this once to start a server to host HTML field in out/public/:

node scripts/server.js

Optionally, you can specify a port:

node scripts/server.js 8080

Doc layout and format

• All docs are located in docs/ with the .md extension. Each file will be a web page.
• Docs use markdown formatting. For help and resources on creating markdown documents, go to the /doctools folder.
• docs/path/to/dir/index.md is special. It is what will be rendered at http://server/path/to/dir/.
• docs/nav.yaml is special. It is used to create left nav.

Workarounds

If you get this error on Windows when running npm install:

Error: ENOENT, stat 'C:\Users\username\AppData\Roaming\npm'

Do this:

mkdir C:\Users\username\AppData\Roaming\npm

How to run script for import into Drupal

If you want to generate the for_import directory to create content in a format for the Drupal import scripts, then run like the following. Note, most everyone will not need to do this.

node scripts/generate.js import