|
1 | 1 | # unpackerr.zip |
2 | 2 |
|
3 | | -[This repository](https://github.com/Unpackerr/unpackerr.github.io) |
4 | | -contains the source and files that create [https://unpackerr.zip](https://unpackerr.zip). |
5 | | - |
6 | | -## Website |
7 | | - |
8 | | -This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. |
9 | | - |
10 | | -## Installation |
11 | | - |
12 | | -Clone the repo, then cd into the new folder and run this first. |
| 3 | +Source for [https://unpackerr.zip](https://unpackerr.zip). Built with [Docusaurus 3](https://docusaurus.io/). |
13 | 4 |
|
14 | 5 | ```console |
15 | 6 | yarn install |
| 7 | +yarn start # local dev server |
| 8 | +yarn build # production build |
| 9 | +yarn lint # markdownlint-cli2 (same as CI) |
| 10 | +codespell docs # brew install codespell |
16 | 11 | ``` |
17 | 12 |
|
18 | | -## Local Development |
19 | | - |
20 | | -**Use this when developing locally!** |
21 | | - |
22 | | -This command starts a local development server and open up a browser window. |
23 | | -Most changes are reflected live without having to restart the server. |
24 | | - |
25 | | -```console |
26 | | -yarn start |
27 | | -``` |
28 | | - |
29 | | -## Build |
30 | | - |
31 | | -This command generates static content into the `build` directory and can be served using apache or nginx, etc. |
32 | | - |
33 | | -```console |
34 | | -yarn build |
35 | | -``` |
36 | | - |
37 | | -## Deployment |
38 | | - |
39 | | -Github Actions automatically builds the `main` branch and pushes it to the `gh-pages` branch. |
40 | | - |
41 | | -## Contributing |
42 | | - |
43 | | -1. Fork the repo. |
44 | | -1. Make your changes; test them with `yarn`. |
45 | | -1. Test `docs/` with `mdl docs` and `codespell docs`. |
46 | | -1. Make a pull request. |
47 | | -1. Bug me on [Discord](https://golift.io/discord) if I don't respond in a timely manner. |
48 | | - |
49 | | -## MDL Linter |
50 | | - |
51 | | -To run the linter locally, I had to do this on my Mac, but `bundler` may work too. |
52 | | -GH actions runs a newer version than 0.11.0, but this worked for me for _something_. |
53 | | - |
54 | | -```shell |
55 | | -brew install rbenv ruby-build |
56 | | -rbenv install 3.2.2 |
57 | | -eval "$(rbenv init -)" |
58 | | -rbenv shell 3.2.2 |
59 | | -gem install --no-document mdl |
60 | | -mdl -g docs |
61 | | -``` |
62 | | - |
63 | | -Seriously, run mdl before committing. |
64 | | - |
65 | | -## Codespell Linter |
66 | | - |
67 | | -```shell |
68 | | -brew install codespell |
69 | | -``` |
| 13 | +Push to `main` deploys to GitHub Pages. |
0 commit comments