Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1.61 KB

docs.md

File metadata and controls

45 lines (27 loc) · 1.61 KB

radpack docs

This document is intended for those authoring documentation. If you're looking for documentation, you can view the latest at https://github.com/pages/godaddy/radpack/

How do docs work?

Documentation is built via Jekyll, and hosted via Github Pages.

Local development

Following the standard instructions provided by GitHub Pages.

After you've satisfied the Prerequisites, you can run your local instance via:

npm run docs

And begin viewing at http://localhost:4000/.

If you experience issues, check out Jekyll on Github Pages.

Folder structure

Structure of docs/ is standard Jekyll:

  • _layouts - default and custom layouts go here.
  • _site - Do not alter this folder directly, Jenkyll will generate this for you.
  • images - Custom images can go here.
  • {NAME}.md - Whatever markdown files you create will be available at /{NAME}.
  • _config.yml - Jekyll config file. Default properties, theme, etc can be provided here.
  • _posts - A collection of documents that will be visible in the navigation bar.

Theme

The current theme is Architect, and is one of many available.