Documentation website for WP Static Site Generator
Herein lies the content for the documentation site, which is viewable at https://wp-static-site-generator-documentation.netlify.com
Contributions are welcome and encouraged - were you trying to follow along with the documentation and discovered something confusing/incorrect/missing?
Simply
- fork this repository into your own GitHub account
- make the changes
- submit a pull request.
As soon as it's merged, it will rebuild the site on the amazing Netlify platform. Your changes will then be publicly viewable shortly after.
If you're making a lot of contributions to the documentation, we'll add you as a contributor, so you can bypass the pull request process for quicker publishing.
- Install Hugo
git clone git@github.com:leonstafford/wp-static-site-generator-documentation.gitcd wp-static-site-generator-documentationhugo server --disableFastRender
The local development server should then be viewable at http://localhost:1313
The site's content primarily lives in the ./content/ directory.
The pages you see in the site's sidebar follow this structure, ie:
├── basics
│ ├── configuration
│ ├── _index.en.md
│ ├── _index.fr.md
│ ├── installation
│ ├── style-customization
│ └── what-is-static
├── cont
│ └── markdown.en.md
├── getting-started
│ ├── configuration
│ ├── _index.en.md
│ ├── _index.fr.md
│ ├── installation
│ ├── requirements
│ └── style-customization
├── _index.en.md
├── posts
│ └── getting-started.md
└── shortcodes
├── _index.en.md
├── _index.fr.md
├── mermaid.en.md
├── mermaid.fr.md
├── notice.en.md
├── notice.fr.md
├── siteparam.en.md
└── ... etc
The theme used is the Learn theme. Appropriate documentation can be found on that site, but the main thing is that we don't modify the Learn theme's files under ./themes/learn/, but buy overriding these, usually in the ./layouts/partials/ directory.
Join the support and development community on Slack, for any questions, discussions about the actual product or it's documentation.