This repository contains the code and content for the cloud.gov website.
cloud.gov is a Platform as a Service based on the Cloud Foundry project, which provides its own Cloud Foundry documentation.
Hugo uses Markdown to build the pages. Add your page to the section you want inside the content folder.
- Install Python 2, if it's not on your system already. (Required for node-sass->node-gyp.)
- Install Hugo.
- Run
npm install
to download all the dependencies. - Run
npm start
and browse to http://localhost:1313.
We usually use branches to write updates. After you merge a PR, click GitHub's button to delete that branch. (We don't need it anymore.)
To link to another page within cg-site, use relref
to create relative links. Examples:
[Example text]({{< relref "directory/filename.md" >}})
[What is cloud.gov?]({{< relref "overview/overview/what-is-cloudgov.md" >}})
[Sharing secret keys]({{< relref "docs/ops/secrets.md#sharing-secret-keys" >}})
If you delete or rename a page, make a redirect to avoid breaking links from other sites: make an alias (use the "YAML frontmatter" style).
If you want to include an image in a page on the site, put it in /static/img/
. Images there will show up at https://cloud.gov/img/example.png
. When you're editing a page, embed them as ![alt text](/img/example.png)
If you want to link to a file, such as a PDF or spreadsheet, put it in /static/resources/
. Resources there will show up at https://cloud.gov/resources/example.pdf
. When you're editing a page, link to them as [link text](/resources/example.pdf)
.
Our search feature is powered by DigitalGov Search, which has a Help Manual with documentation about configuring it. DigitalGov Search for Power Users is also useful.
We use its default Bing indexing, so our search may show outdated results if Bing hasn't recently reindexed our docs site.
This site uses a shared cloud.gov style, cg-style. This means any styling code has to be developed in cg-style.
- Download or clone the cg-style repository,
git clone git@github.com:18F/cg-style.git
- Run
npm link
in cg-style. - Run the watching build task in the cg-style repository:
npm run watch
- Run
npm link cloudgov-style
in cg-site. - Run
npm install
in the cg-site repository. - Run the watching build task in cg-site repository:
npm run watch
- Edit code in the cg-style directory and they will propagate down to cg-site
The theme for the site has been "forked" from the Hugo documentation.