معرفی شرکت ها
coltrane-0.24.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
A simple content site framework that harnesses the power of Django without the hassle.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | coltrane-0.24.0 |
| نام | coltrane |
| نسخه کتابخانه | 0.24.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | adamghill |
| ایمیل نویسنده | adam@adamghill.com |
| آدرس صفحه اصلی | https://github.com/adamghill/coltrane/ |
| آدرس اینترنتی | https://pypi.org/project/coltrane/ |
| مجوز | MIT |
<p align="center">
<a href="https://coltrane.readthedocs.io"><h1 align="center">coltrane</h1></a>
</p>
<p align="center">A simple content site framework that harnesses the power of Django without the hassle 🎵</p>
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-BADGE:END -->
📖 Complete documentation: https://coltrane.readthedocs.io
📦 Package located at https://pypi.org/project/coltrane/
## ⭐ Features
- Can either generate a static HTML site, be deployed as a standalone Django site, or integrated into an existing Django site
- Reads markdown content and renders it in HTML
- Can use data from JSON files in templates and markdown content
- Automatic generation of `sitemap.xml` and `rss.xml` files
- Can also serve non-markdown files like `robots.txt`
- [Live re-rendering of markdown and data](https://twitter.com/adamghill/status/1487522925393715205) when markdown or JSON data files are saved with the magic of https://github.com/adamchainz/django-browser-reload
- All the power of Django templates, template tags, and filters inside markdown files
- Can include other Django apps for additional functionality
- Custom Template tags are supported and are enabled automatically for use in markdown content
- Opinionated standalone Django project setup where deployment (including static files) just works "out of the box"
## ⚡ Quick start for a new static site
1. `mkdir new-site && cd new-site` to create a new folder
1. `poetry init --no-interaction --dependency 'coltrane:<1' && poetry install` to create a new virtual environment and install the `coltrane` package
1. `poetry run coltrane create` to create the folder structure for a new site
1. Update `content/index.md`
1. `poetry run coltrane play` for a local development server
1. Go to http://localhost:8000 to see the updated markdown rendered into HTML
1. `poetry run coltrane record` to output the rendered HTML files
### Optional installation
- Enable `watchman` for less resource-intensive autoreload on MacOS: `brew install watchman`
## ➕ How to add new content
Add markdown files or sub-directories with markdown files to the `content` directory and they will automatically have routes created that can be requested.
**Example markdown files**
```
content/index.md
content/about.md
content/articles/this-is-the-first-article.md
```
**`poetry run coltrane play` will serve these URLs**
- `http://localhost:8000/` which serves HTML generated from the `/content/index.md` file
- `http://localhost:8000/about/` which serves HTML generated from the `/content/about.md` file
- `http://localhost:8000/articles/this-is-the-first-article/` which serves HTML generated from the `/content/articles/this-is-the-first-article.md` file
- `http://localhost:8000/not-there/` will 404
**`poetry run coltrane record` will create these HTML files for a static site**
- `output/index.html`
- `output/about/index.html`
- `output/articles/this-is-the-first-article/index.html`
Read all of the documentation at https://coltrane.readthedocs.io.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center"><a href="https://github.com/Tobi-De"><img src="https://avatars.githubusercontent.com/u/40334729?v=4?s=100" width="100px;" alt="Tobi DEGNON"/><br /><sub><b>Tobi DEGNON</b></sub></a><br /><a href="https://github.com/adamghill/coltrane/commits?author=Tobi-De" title="Tests">⚠️</a> <a href="https://github.com/adamghill/coltrane/commits?author=Tobi-De" title="Code">💻</a></td>
</tr>
</tbody>
<tfoot>
</tfoot>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
نیازمندی
| مقدار | نام |
|---|---|
| >3.0 | Django |
| >0.17 | python-dotenv |
| >=2.4.2,<3.0.0 | markdown2 |
| >=8.0.0,<9.0.0 | click |
| >=1.3.0,<2.0.0 | django-browser-reload |
| >=0.0.31,<0.0.32 | halo |
| >=0.2.0,<0.3.0 | rich-click |
| >=1.3.0,<2.0.0 | django-fastdev |
| >=1.1.0,<2.0.0 | dateparser |
| >=3.0.0rc4,<4.0.0 | mistune |
| >=1.0.0,<2.0.0 | python-frontmatter |
| >=2.7.3 | pygments |
| >=0.6.2 | minestrone |
| >=4.3.2,<5.0.0 | Sphinx |
| >=1.0.3,<2.0.0 | linkify-it-py |
| >=0.16.1,<0.17.0 | myst-parser |
| >=2021.11.23,<2022.0.0 | furo |
| >=0.4.0,<0.5.0 | sphinx-copybutton |
| >=2021.3.14,<2022.0.0 | sphinx-autobuild |
| - | toml |
| >=21.4.0,<22.0.0 | attrs |
| >=20.1.0,<21.0.0 | gunicorn |
| >=5.3.0,<6.0.0 | whitenoise |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7,<4.0 | Python |
نحوه نصب
نصب پکیج whl coltrane-0.24.0:
pip install coltrane-0.24.0.whl
نصب پکیج tar.gz coltrane-0.24.0:
pip install coltrane-0.24.0.tar.gz