mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-26 19:53:59 -05:00
docs: run lint:fix
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
parent
50d4959e0a
commit
e8e72c5328
6 changed files with 26 additions and 10 deletions
|
@ -7,7 +7,9 @@
|
|||
Each note in HedgeDoc 2 contains the following information:
|
||||
|
||||
- publicId (`b604x5885k9k01bq7tsmawvnp0`)
|
||||
- a list of aliases (`[HedgeDoc-2, HedgeDoc-next]`)
|
||||
<!-- markdownlint-disable proper-names -->
|
||||
- a list of aliases (`[hedgedoc-2, hedgedoc-next]`)
|
||||
<!-- markdownlint-enable proper-names -->
|
||||
- groupPermissions
|
||||
- userPermissions
|
||||
- viewCount (`0`)
|
||||
|
|
|
@ -5,14 +5,18 @@ Make sure that you have installed the [Docker BuildKit Plugin][buildkit] and
|
|||
execute the commands from the root level of the project.
|
||||
Otherwise, the build process may fail.
|
||||
|
||||
<!-- markdownlint-disable proper-names -->
|
||||
```sh
|
||||
docker buildx build -f backend/docker/Dockerfile -t HedgeDoc-backend .
|
||||
docker buildx build -f backend/docker/Dockerfile -t hedgedoc-backend .
|
||||
```
|
||||
<!-- markdownlint-enable proper-names -->
|
||||
|
||||
or
|
||||
|
||||
<!-- markdownlint-disable proper-names -->
|
||||
```sh
|
||||
docker buildx build -f frontend/docker/Dockerfile -t HedgeDoc-frontend .
|
||||
docker buildx build -f frontend/docker/Dockerfile -t hedgedoc-frontend .
|
||||
```
|
||||
<!-- markdownlint-enable proper-names -->
|
||||
|
||||
[buildkit]: https://docs.docker.com/build/install-buildx/
|
||||
|
|
|
@ -5,7 +5,9 @@ Our documentation is build with [mkdocs][mkdocs].
|
|||
## Writing
|
||||
|
||||
All documentation files are found in the `docs/content` directory of
|
||||
the [HedgeDoc/HedgeDoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal
|
||||
<!-- markdownlint-disable proper-names -->
|
||||
the [hedgedoc/hedgedoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal
|
||||
<!-- markdownlint-enable proper-names -->
|
||||
markdown files with nothing special about them.
|
||||
|
||||
The configuration for mkdocs lies in the `docs` folder in a file called `mkdocs.yml`. With that file
|
||||
|
@ -27,8 +29,10 @@ To build the documentation locally you need to perform the following steps:
|
|||
|
||||
The documentation is deployed with [mkdocs][mkdocs].
|
||||
|
||||
The repository [docs.HedgeDoc.org][docs.HedgeDoc.org] is used to deploy the actual website
|
||||
<!-- markdownlint-disable proper-names -->
|
||||
The repository [docs.hedgedoc.org][docs.hedgedoc.org] is used to deploy the actual website
|
||||
<!-- markdownlint-enable proper-names -->
|
||||
to github.io. Currently only the `master` branch is deployed as it contains the latest release.
|
||||
|
||||
[mkdocs]: https://www.mkdocs.org
|
||||
[docs.HedgeDoc.org]: https://github.com/hedgedoc/docs.hedgedoc.org
|
||||
[docs.hedgedoc.org]: https://github.com/hedgedoc/docs.hedgedoc.org
|
||||
|
|
|
@ -18,10 +18,12 @@ and the provided configuration.
|
|||
|
||||
1. Clone [our repository][hedgedoc-repo] and go into its directory
|
||||
|
||||
<!-- markdownlint-disable proper-names -->
|
||||
```shell
|
||||
git clone https://github.com/hedgedoc/hedgedoc.git
|
||||
cd HedgeDoc
|
||||
cd hedgedoc
|
||||
```
|
||||
<!-- markdownlint-enable proper-names -->
|
||||
|
||||
2. Install Node.js. You need at least Node 16, but we recommend Node 20.
|
||||
3. Install [Yarn][yarn]
|
||||
|
@ -48,7 +50,9 @@ If you want to run HedgeDoc in dev mode some preconditions have to be met.
|
|||
|
||||
1. Make sure that Node.js is installed. You need at least Node 16, but we recommend Node 18.
|
||||
2. Make sure that [Yarn][yarn] is installed.
|
||||
3. Clone this repo (e.g. `git clone https://github.com/hedgedoc/hedgedoc.git HedgeDoc`)
|
||||
<!-- markdownlint-disable proper-names -->
|
||||
3. Clone this repo (e.g. `git clone https://github.com/hedgedoc/hedgedoc.git hedgedoc`)
|
||||
<!-- markdownlint-enable proper-names -->
|
||||
4. Go into the cloned directory
|
||||
|
||||
## Installing the dependencies
|
||||
|
|
|
@ -7,7 +7,9 @@
|
|||
|
||||
🚧⚠️🚧 **HedgeDoc 2.0 is still in development!**
|
||||
You are probably looking for the 1.x docs.
|
||||
Find them in the `master` branch and on [docs.HedgeDoc.org](https://docs.hedgedoc.org).
|
||||
<!-- markdownlint-disable proper-names -->
|
||||
Find them in the `master` branch and on [docs.hedgedoc.org](https://docs.hedgedoc.org).
|
||||
<!-- markdownlint-enable proper-names -->
|
||||
|
||||
If you want to help us to develop HedgeDoc 2, join us on [Matrix][matrix.org-url]!
|
||||
|
||||
|
|
|
@ -17,7 +17,7 @@ You will have to accept the TLS warning in your browser the first time the page
|
|||
!!! danger "HedgeDoc 2 is not yet production ready!"
|
||||
This section explains how a production deployment of HedgeDoc 2 on a publicly accessible domain
|
||||
might look in the future.
|
||||
HedgeDoc 2 itself is not production ready yet, so only use these instructions to set up an
|
||||
HedgeDoc 2 itself is not production ready yet, so only use these instructions to set up an
|
||||
instance for testing with your friends.
|
||||
|
||||
For a production setup, first set a unique session secret with
|
||||
|
|
Loading…
Reference in a new issue