https://github.com/penpot/penpot-docs
Website and documentation about Penpot, The Open-Source design & prototyping platform
https://github.com/penpot/penpot-docs
Last synced: 8 months ago
JSON representation
Website and documentation about Penpot, The Open-Source design & prototyping platform
- Host: GitHub
- URL: https://github.com/penpot/penpot-docs
- Owner: penpot
- License: mpl-2.0
- Created: 2021-02-11T10:22:46.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T12:33:39.000Z (over 1 year ago)
- Last Synced: 2024-04-22T12:44:42.473Z (over 1 year ago)
- Language: Nunjucks
- Homepage:
- Size: 58.2 MB
- Stars: 109
- Watchers: 12
- Forks: 100
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- Awesome-NAS-Docker - 项目地址 - docs?&label=) |  | (置顶 / 1、AI应用生态)
README
> [!WARNING]
> The content of this repository is outdated. Currently, the documentation is located in [the main penpot repository](https://github.com/penpot/penpot/tree/develop/docs) where it is up to date.
# 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).
## License
See [LICENSE](./LICENSE)