s-matyukevich / cg-docs

Documentation site for cloud.gov Cloud Foundry

18F CF Docs

This repository contains the site code for the 18F Cloud Foundry documentation.

Contributing

Hugo uses markdown to build the pages. Just add your page to the section you want inside the content folder.

Running the site locally

1. This project uses Hugo to build the site. Once Hugo is installed, run hugo to build the site.
2. Run npm install to download all the dependencies.
3. Run npm run start and browse to http://localhost:1313.

Style development

This site uses a shared cloud.gov style, cg-style. This means any styling code has to be developed in cg-style.

1. Download or clone the cg-style repository, git clone [email protected]:18F/cg-style.git
2. Run the watching build task in the cg-style repository: npm run watch
3. Run npm install in the cg-docs repository.
4. Run npm link in cg-docs.
5. Run the watching build task in cg-docs repository: npm run watch
6. Edit code in the cg-style directory and they will propagate down to cg-docs

Acknowledgement

The theme for the site has been "forked" from the Hugo documentation.