mirror of
https://github.com/dathere/de-intern-guide.git
synced 2025-12-19 08:39:25 +00:00
35 lines
1 KiB
Markdown
35 lines
1 KiB
Markdown
# 🤝 Contributing
|
|
|
|
## Writing Content
|
|
|
|
The site is generated based on the content in the `docs` folder. Each folder in `docs` represents a section of the site. Each `.md` and `.mdx` file in a folder represents a page in that section. You can learn more by reading more about [Docusaurus](https://github.com/facebook/docusaurus), the static site generator used to build this site.
|
|
|
|
I recommend keeping a consistent format throughout the guide. For example, preceding each section title is a relevant emoji.
|
|
|
|
## Installation
|
|
|
|
Install all required dependencies:
|
|
|
|
```
|
|
$ npm i
|
|
```
|
|
|
|
## Local Development
|
|
|
|
```
|
|
$ npm start
|
|
```
|
|
|
|
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
|
|
|
|
## Build
|
|
|
|
```
|
|
$ npm build
|
|
```
|
|
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
|
|
|
## Deployment
|
|
|
|
The site is [deployed through GitHub Pages](https://docusaurus.io/docs/deployment#deploying-to-github-pages).
|