https://github.com/lnxpy/docket
Django Documentation Generator in ckeditor
https://github.com/lnxpy/docket
Last synced: 3 months ago
JSON representation
Django Documentation Generator in ckeditor
- Host: GitHub
- URL: https://github.com/lnxpy/docket
- Owner: lnxpy
- License: mit
- Created: 2020-03-28T13:32:40.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-09-22T18:47:51.000Z (almost 5 years ago)
- Last Synced: 2025-03-16T14:36:55.824Z (over 1 year ago)
- Language: Python
- Size: 276 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docket
Easy way to generate some documents by versioning them into the ckeditor WYSIWYG editor. Make documents in a second and toggle them into your `Document` indexes.
# Structure
You can generate lots of documents for your project. docket uses Bootstrap 4 which is so flexible for API generations. Write your scripts, headers, paragraphs, and quotas in the ckeditor and let Bootstrap style them.
# Preview
Here is the list that you would create on the Django Admin Panel(DAP). DAP is available on `localhost:8000/admin` by default. You might have chosen a different port address or already changed the DAP path.
Now, here we have our document viewer which has been designed by Bootstrap. Modify classes, make some CSS codes, and create your own favorite scheme. Here is the default scheme of the Docket.
# Setup your Scheme
You may not prefer the default scheme of docket. Don't concern about it. Make it looks better. You have to be familiar with CSS and design your tags properly. The changes you make will be overwrititten on the default styles of Bootstrap.
Also use `pygmentify` to beautify your JSON, Script, and Code blocks and give them a better design. If you want to set it up, make sure you have already read the [official pygmentify document](https://django-pygmentify.readthedocs.io/en/latest/usage.html).
# Fork
Fork and feed for free :)