Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sobolevbel/jdg
Гайд-путеводитель по JDG (ИП) в Польше
https://github.com/sobolevbel/jdg
business documentation guide hacktoberfest jdg markdown mkdocs poland
Last synced: 30 days ago
JSON representation
Гайд-путеводитель по JDG (ИП) в Польше
- Host: GitHub
- URL: https://github.com/sobolevbel/jdg
- Owner: sobolevbel
- License: cc0-1.0
- Created: 2021-07-15T05:19:01.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-23T18:54:42.000Z (about 2 months ago)
- Last Synced: 2024-10-01T10:01:45.057Z (about 1 month ago)
- Topics: business, documentation, guide, hacktoberfest, jdg, markdown, mkdocs, poland
- Language: Markdown
- Homepage: https://sobolevbel.github.io/jdg/
- Size: 30.5 MB
- Stars: 366
- Watchers: 13
- Forks: 103
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Support: docs/support.md
Awesome Lists containing this project
README
# JDG (Jednoosobowa działalność gospodarcza) — ИП в Польше
[Перейти на сайт](https://sobolevbel.github.io/jdg/)
Для сборки сайта из `markdown` файлов используется генератор статических сайтов [MkDocs](https://www.mkdocs.org/).
С синтаксисом markdown можно ознакомиться [здесь](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
## Как поучаствовать в проекте
1. Форкните проект, создайте новую ветку и начинайте работу.
2. Когда работа будет готова — проверьте локально что сайт собирается и запушьте ветку в репозиторий.
3. Создайте Pull Request в master.
Пошаговые инструкции:
1. От GitHub, на английском: [Creating a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
2. На русском [GitHub - Внесение собственного вклада в проекты](https://git-scm.com/book/ru/v2/GitHub-%D0%92%D0%BD%D0%B5%D1%81%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BE%D0%B1%D1%81%D1%82%D0%B2%D0%B5%D0%BD%D0%BD%D0%BE%D0%B3%D0%BE-%D0%B2%D0%BA%D0%BB%D0%B0%D0%B4%D0%B0-%D0%B2-%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D1%8B)
## Процесс работы
### Нормальный способ
Для локальной сборки сайта необходимо установить:
- python 3+
- зависимости проекта
Для установки зависимостей проекта используйте команду
```shell
pip install -r requirements.txt
```
Запустить проект:
```shell
python -m mkdocs serve
```
### Docker-way 🙃
Нужен:
- docker
А дальше запускаете:
```shell
docker compose up --build
```
### Obsidian
Или можете просто установить Obsidian и в нём редактировать и сразу видеть отрендеренный Markdown.
```
,-. _,---._ __ / \
/ ) .-' `./ / \
( ( ,' `/ /|
\ `-" \'\ / |
`. , \ \ / |
/`. ,'-`----Y |
( ; | '
| ,-. ,-' | /
| | ( | | /
) | \ `.___________|/
`--' `--'
```