2021-02-11 10:22:46 +00:00
|
|
|
# penpot-docs
|
2021-02-11 16:10:10 +00:00
|
|
|
Penpot documentation website
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
To view this site locally, first set up the environment:
|
|
|
|
|
|
|
|
|
|
```
|
2022-09-05 09:06:50 +00:00
|
|
|
nvm install (if necessary)
|
2021-02-11 16:10:10 +00:00
|
|
|
nvm use
|
2024-04-11 10:38:24 +00:00
|
|
|
corepack enable (if necessary)
|
2022-09-05 09:06:50 +00:00
|
|
|
|
2024-04-11 10:38:24 +00:00
|
|
|
yarn install
|
2021-02-11 16:10:10 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
And launch a development server:
|
|
|
|
|
|
|
|
|
|
```
|
2022-09-05 09:06:50 +00:00
|
|
|
yarn run start
|
2021-02-11 16:10:10 +00:00
|
|
|
```
|
|
|
|
|
|
2021-11-23 13:06:30 +00:00
|
|
|
You can then point a browser to [http://localhost:8080](http://localhost:8080).
|
2021-02-11 16:10:10 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Tooling
|
|
|
|
|
|
|
|
|
|
* [Eleventy (11ty)](https://www.11ty.dev/docs)
|
|
|
|
|
* [Diagrams](https://github.com/gmunguia/markdown-it-plantuml) with
|
|
|
|
|
[plantuml](https://plantuml.com). See also
|
|
|
|
|
[real-world-plantuml](https://real-world-plantuml.com).
|
|
|
|
|
* [Diagrams](https://github.com/agoose77/markdown-it-diagrams) with
|
|
|
|
|
[svgbob](https://github.com/ivanceras/svgbob) and
|
|
|
|
|
[mermaid](https://github.com/mermaid-js/mermaid).
|
|
|
|
|
* [arc42](https://arc42.org/overview) template.
|
|
|
|
|
* [c4model](https://c4model.com) for software architecture, and an
|
|
|
|
|
[implementation in plantuml](https://github.com/plantuml-stdlib/C4-PlantUML).
|
|
|
|
|
|
2021-04-12 17:09:26 +00:00
|
|
|
|
|
|
|
|
## License ##
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
|
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
|
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
|
|
|
|
|
|
Copyright (c) UXBOX Labs SL
|
|
|
|
|
```
|
