mirror of
https://github.com/penpot/penpot-docs.git
synced 2024-07-01 04:53:15 +00:00
Website and documentation about Penpot, The Open-Source design & prototyping platform
|
|
||
|---|---|---|
| _data | ||
| _includes/layouts | ||
| contributing-guide | ||
| css | ||
| feed | ||
| img | ||
| js | ||
| scripts | ||
| technical-guide | ||
| user-guide | ||
| .editorconfig | ||
| .eleventy.js | ||
| .eleventyignore | ||
| .gitignore | ||
| .nvmrc | ||
| .yarnrc.yml | ||
| 404.md | ||
| CONTRIBUTING.md | ||
| index.njk | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| search-index.json.njk | ||
| sitemap.xml.njk | ||
| yarn.lock | ||
penpot-docs
Penpot documentation website
Usage
To view this site locally, first set up the environment:
nvm install (if necessary)
nvm use
corepack enable (if necessary)
yarn install
And launch a development server:
yarn run 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.
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