|
1 | | -# Website |
| 1 | +<div style="text-align: center" align="center"> |
| 2 | + <img alt="Open Sauced" src="https://i.ibb.co/7jPXt0Z/logo1-92f1a87f.png" width="300px" /> |
2 | 3 |
|
3 | | -This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. |
| 4 | +# docs.opensauced.pizza |
| 5 | +> The path to your next Open Source contribution |
4 | 6 |
|
5 | | -## Installation |
| 7 | +[](https://github.com/open-sauced/explore.opensauced.pizza/pulse) |
| 8 | +[](https://github.com/open-sauced/explore.opensauced.pizza/issues) |
| 9 | +[](https://github.com/open-sauced/explore.opensauced.pizza/releases) |
| 10 | +[](https://discord.gg/U2peSNf23P) |
| 11 | +[](https://twitter.com/saucedopen) |
6 | 12 |
|
7 | | -```console |
8 | | -yarn install |
9 | | -``` |
| 13 | +</div> |
10 | 14 |
|
11 | | -## Local Development |
| 15 | +## 🧪 Built for Experimenting |
12 | 16 |
|
13 | | -```console |
14 | | -yarn start |
15 | | -``` |
| 17 | +This tool is meant to accelerate development on [Open Sauced](https://opensauced.pizza) by giving contributors a way to access [Docusaurus 2](https://docusaurus.io/) powered developer documentation available at [docs.opensauced.pizza](https://docs.opensauced.pizza). |
| 18 | + |
| 19 | +## 🤝 Contributing |
16 | 20 |
|
17 | | -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. |
| 21 | +We encourage you to contribute to Open Sauced! Please check out the [Contributing guide](CONTRIBUTING.md) for guidelines about how to proceed. |
18 | 22 |
|
19 | | -## Build |
| 23 | +<img align="right" src="https://i.ibb.co/CJfW18H/ship.gif" width="200"/> |
20 | 24 |
|
21 | | -```console |
22 | | -yarn build |
| 25 | +## 🖥️ Development |
| 26 | + |
| 27 | +```sh |
| 28 | +npm ci |
| 29 | +npm start |
23 | 30 | ``` |
24 | 31 |
|
25 | | -This command generates static content into the `build` directory and can be served using any static contents hosting service. |
| 32 | +## 🍕 Community |
26 | 33 |
|
27 | | -## Deployment |
| 34 | +Got Questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P). |
| 35 | +Find Open Sauced videos and release overviews on our [YouTube Channel](https://www.youtube.com/channel/UCklWxKrTti61ZCROE1e5-MQ). |
28 | 36 |
|
29 | | -```console |
30 | | -GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy |
31 | | -``` |
| 37 | +## ⚖️ LICENSE |
32 | 38 |
|
33 | | -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
| 39 | +MIT © [Open Sauced](LICENSE) |
0 commit comments