<div align="center">
<a href="#"><img width="400" src="https://raw.githubusercontent.com/sujaudd1n/scribo/main/docs/assets/static/scribo.png" alt="Scribo logo"></a>
</div>
<p align="center">
A simple, efficient and content-first static site generator (SSG).
</p>
<div align="center">

[](https://pypi.org/project/scribo)
</div>
Write docs, blogs or anything you like. Read the [docs](https://scribo-docs.netlify.app).
## Features
- Extended markdown syntax support
- File-system based routing
- Customization
- Automatic table of contents generation
- Syntax highlighting of codeblocks
- Metadata
## Installation
```console
pip install scribo
```
## Quick Start
### Initialize
```bash
scribo --init sitename
```
Edit `index.md`.
### Build
```console
scribo --build sitename
```
`dist` dir contains the build of the project.
## Contributing
Please read [CONTRIBUTING.md](./CONTRIBUTING.md).
## License
`scribo` is distributed under the terms of the [MIT](./LICENSE) license.
Raw data
{
"_id": null,
"home_page": null,
"name": "scribo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "documentation, jinja, markdown, scribo, static-site-generator",
"author": "Md Sujauddin Sekh",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/c9/ce/4e0c1b515012f10b8faa65c138356cfbfd249ba60530f409e9f8e3db4dfe/scribo-1.0.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <a href=\"#\"><img width=\"400\" src=\"https://raw.githubusercontent.com/sujaudd1n/scribo/main/docs/assets/static/scribo.png\" alt=\"Scribo logo\"></a>\n</div>\n\n<p align=\"center\">\nA simple, efficient and content-first static site generator (SSG). \n</p>\n\n\n<div align=\"center\">\n\n\n[](https://pypi.org/project/scribo)\n \n</div>\n\nWrite docs, blogs or anything you like. Read the [docs](https://scribo-docs.netlify.app).\n\n## Features\n\n- Extended markdown syntax support\n- File-system based routing\n- Customization\n- Automatic table of contents generation\n- Syntax highlighting of codeblocks\n- Metadata\n\n\n## Installation\n\n```console\npip install scribo\n```\n\n## Quick Start\n\n### Initialize\n\n```bash\nscribo --init sitename\n```\n\nEdit `index.md`.\n\n### Build\n\n```console\nscribo --build sitename\n```\n\n`dist` dir contains the build of the project.\n\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](./CONTRIBUTING.md).\n\n## License\n\n`scribo` is distributed under the terms of the [MIT](./LICENSE) license.\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple, efficient and content-first static site generator (SSG).",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://github.com/sujaudd1n/scribo#readme",
"Issues": "https://github.com/sujaudd1n/scribo/issues",
"Source": "https://github.com/sujaudd1n/scribo"
},
"split_keywords": [
"documentation",
" jinja",
" markdown",
" scribo",
" static-site-generator"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5f1c122fe7e1b5db5956075e7a6eda4a5605b679de8373959fe253e6616388e9",
"md5": "f89026f34b670448f78abc3ea63fe235",
"sha256": "77b23b470720f1eec33c93277faa0cc0565c3032bbd5031c2755a9a3cdb4b1e0"
},
"downloads": -1,
"filename": "scribo-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f89026f34b670448f78abc3ea63fe235",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 913116,
"upload_time": "2025-02-01T04:16:24",
"upload_time_iso_8601": "2025-02-01T04:16:24.533201Z",
"url": "https://files.pythonhosted.org/packages/5f/1c/122fe7e1b5db5956075e7a6eda4a5605b679de8373959fe253e6616388e9/scribo-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c9ce4e0c1b515012f10b8faa65c138356cfbfd249ba60530f409e9f8e3db4dfe",
"md5": "256a87aeae0ae8c006ee739fc5f92b65",
"sha256": "1e757cd8b0e7808ddb676ede96f33be58d8f8a497064317130b5aa2958eeba7a"
},
"downloads": -1,
"filename": "scribo-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "256a87aeae0ae8c006ee739fc5f92b65",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 918550,
"upload_time": "2025-02-01T04:16:27",
"upload_time_iso_8601": "2025-02-01T04:16:27.842697Z",
"url": "https://files.pythonhosted.org/packages/c9/ce/4e0c1b515012f10b8faa65c138356cfbfd249ba60530f409e9f8e3db4dfe/scribo-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-01 04:16:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sujaudd1n",
"github_project": "scribo#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "scribo"
}