generator-canonical-documentation
v0.1.2
Published
A skeleton example of Markdown documentation in the recommended structure to be build with documentation-builder
Downloads
5
Readme
Yeoman generator for Canonical documentation
This is a yeoman generator for quickly genrating a skeleton project of documentation in Markdown format, according to the recommended structure we use at Canonical:
Starting a new repository
To generate a new documentation repository:
sudo npm install -g generator-canonical-documentation # Install the generator
mkdir my-documentation # Create your new folder
cd my-documentation # Change to the directory
yo canonical-documentation
This will create a skeleton of your documentation files.
Repository structure
├── en
│ ├── index.md # The first page of documentation
│ └── metadata.yaml # Contains the navigation for English pages
├── media # A folder to keep images and other media
│ └── logo.png # An example logo
├── metadata.yaml # Contains global site information
├── README.md # About this documentation
└── versions # Version branches to build
This documentation can then be built using the documentation-buider:
$ documentation-builder
Skipping uppercase files:
- README.md
Built:
- build/en/index.html
Copied ./media to build/media