mirror of
https://github.com/penpot/penpot.git
synced 2025-01-06 14:50:20 -05:00
38 lines
939 B
Markdown
38 lines
939 B
Markdown
# Penpot Docs
|
|
|
|
Penpot documentation website.
|
|
|
|
## Usage
|
|
|
|
To view this site locally, first set up the environment:
|
|
|
|
```sh
|
|
# only if necessary
|
|
nvm install
|
|
nvm use
|
|
# only if necessary
|
|
corepack enable
|
|
|
|
yarn install
|
|
```
|
|
|
|
And launch a development server:
|
|
|
|
```sh
|
|
yarn start
|
|
```
|
|
|
|
You can then point a browser to [http://localhost:8080](http://localhost:8080).
|
|
|
|
## 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).
|