955bdcb2bc
* Rename all GitHub links from thepracticaldev/dev.to to forem/forem * Use new site name * Rename to Forem * Rename more dev.to to forem * Remove unnecessary redirects * Rename DEV to Forem * Use Forem instead of DEV for branding * Use Forem instead of DEV for licensing * Use seedling instead of DEV logo
75 lines
1.9 KiB
Markdown
75 lines
1.9 KiB
Markdown
---
|
|
items:
|
|
- technical-overview
|
|
- installation
|
|
- getting-started
|
|
- contributing
|
|
- backend
|
|
- frontend
|
|
- internal
|
|
- design
|
|
- tests
|
|
- faqs.md
|
|
- troubleshooting.md
|
|
- licensing.md
|
|
- self-hosting.md
|
|
- maintainers
|
|
---
|
|
|
|
# Welcome to Forem's developer documentation
|
|
|
|
On this site you'll find instructions to setup a [local instance of
|
|
Forem][installation], documentation on the [architecture of
|
|
Forem][architecture], [how to contribute][contributing], and many other useful
|
|
documents.
|
|
|
|
This documentation site is the product of a number of volunteer contributors
|
|
working alongside the Forem Core Team, special thanks to all those who have
|
|
contributed to the documentation.
|
|
|
|
# Running the documentation locally
|
|
|
|
Like Forem, this site is open source and the code is [hosted on GitHub][docs].
|
|
If you find any incorrect information, or a even a typo, we'd love to see a pull
|
|
request. Follow these steps to get the documentation site running locally.
|
|
|
|
Forem's documentation is built with [GitDocs NodeJS library][gitdocs].
|
|
|
|
The first step to running the documentations locally is to install the `GitDocs`
|
|
package globally.
|
|
|
|
With npm:
|
|
|
|
```shell
|
|
npm install gitdocs -g
|
|
```
|
|
|
|
Alternatively, you can use Yarn:
|
|
|
|
```shell
|
|
yarn global add gitdocs
|
|
```
|
|
|
|
Once installed, you should run `gitdocs serve` from the root of the `forem`
|
|
project or from the `/docs` directory.
|
|
|
|
```shell
|
|
gitdocs serve
|
|
```
|
|
|
|
This will start a server where you can browse the documentation:
|
|
<http://localhost:8000/>
|
|
|
|
If you add new pages or rename existing pages, you'll need to restart the server
|
|
for those changes to take effect.
|
|
|
|
# Contributing to the docs
|
|
|
|
If you're looking for more information on contributing, check out the
|
|
[Contributing guide][contributing].
|
|
|
|
[installation]: /installation/
|
|
[architecture]: /technical-overview/architecture/
|
|
[contributing]: /contributing/
|
|
[docs]: https://github.com/forem/forem/tree/master/docs/
|
|
[gitdocs]: https://www.npmjs.com/package/gitdocs/
|