Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-26 13:04:10 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add note about Hugo 0.93

Browse source
This commit is contained in:
Alex Kirk 2023-06-27 04:24:10 +02:00 committed by GitHub
parent 30845e189f
commit 3e4ed2dfcd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -58,22 +58,23 @@ Additionally, the following directories may be of interest:
Please read [CONTRIBUTING.rst](./CONTRIBUTING.rst) before authoring a change to the spec. Note that spec authoring takes Please read [CONTRIBUTING.rst](./CONTRIBUTING.rst) before authoring a change to the spec. Note that spec authoring takes
place after an MSC has been accepted, not as part of a proposal itself. place after an MSC has been accepted, not as part of a proposal itself.
1. Install the extended version (often the OS default) of Hugo: 1. Install the extended version (often the OS default) of Hugo in version 0.93:
<https://gohugo.io/getting-started/installing>. Note that at least Hugo <https://github.com/gohugoio/hugo/releases/tag/v0.93.3>
v0.93.0 is required. Download the right `hugo_extended_*` for your platform and put it in your file path or the root directory and
remember to execute it from there). Note that currently the spec won't build in newer Hugo versions.
Alternatively, use the Docker image at Alternatively, use the Docker image at
https://hub.docker.com/r/klakegg/hugo/. (The "extended edition" is required https://hub.docker.com/r/klakegg/hugo/. (The "extended edition" is required
to process the SCSS.) to process the SCSS.)
2. Run `npm i` to install the dependencies and fetch the docsy git submodule. 3. Run `npm i` to install the dependencies and fetch the docsy git submodule.
Note that this will require NodeJS to be installed. Note that this will require NodeJS to be installed.
3. Run `npm run get-proposals` to seed proposal data. This is merely for populating the content of the "Spec Change Proposals" 4. Run `npm run get-proposals` to seed proposal data. This is merely for populating the content of the "Spec Change Proposals"
page and is not required. page and is not required.
4. Run `hugo serve` (or `docker run --rm -it -v $(pwd):/src -p 1313:1313 5. Run `hugo serve` (or `docker run --rm -it -v $(pwd):/src -p 1313:1313
klakegg/hugo:ext serve`) to run a local webserver which builds whenever a file klakegg/hugo:ext serve`) to run a local webserver which builds whenever a file
change is detected. If watching doesn't appear to be working for you, try change is detected. If watching doesn't appear to be working for you, try
adding `--disableFastRender` to the commandline. adding `--disableFastRender` to the commandline.
5. Edit the specification 🙂 6. Edit the specification 🙂
We use a highly customized [Docsy](https://www.docsy.dev/) theme for our generated site, which uses Bootstrap and Font We use a highly customized [Docsy](https://www.docsy.dev/) theme for our generated site, which uses Bootstrap and Font
Awesome. If you're looking at making design-related changes to the spec site, please coordinate with us in Awesome. If you're looking at making design-related changes to the spec site, please coordinate with us in