mirror of https://github.com/penpot/penpot.git
Co-authored-by: Andres Gonzalez <andres.gonzalez79@gmail.com> |
||
|---|---|---|
| .. | ||
| .vscode | ||
| _data | ||
| _includes/layouts | ||
| contributing-guide | ||
| css | ||
| feed | ||
| img | ||
| js | ||
| plugins | ||
| scripts | ||
| technical-guide | ||
| user-guide | ||
| .editorconfig | ||
| .eleventy.js | ||
| .eleventyignore | ||
| .gitignore | ||
| .yarnrc.yml | ||
| 404.md | ||
| README.md | ||
| _redirects | ||
| index.njk | ||
| package.json | ||
| search-index.json.njk | ||
| sitemap.xml.njk | ||
| yarn.lock | ||
README.md
Penpot Docs
Penpot documentation website.
Usage
To view this site locally, first set up the environment:
# only if necessary
nvm install
nvm use
# only if necessary
corepack enable
yarn install
And launch a development server:
yarn start
You can then point a browser to http://localhost:8080.
Tooling
- Eleventy (11ty)
- Diagrams with plantuml. See also real-world-plantuml.
- Diagrams with svgbob and mermaid.
- arc42 template.
- c4model for software architecture, and an implementation in plantuml.