Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Holocron to power its documentation #267

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

ikalnytskyi
Copy link
Owner

@ikalnytskyi ikalnytskyi commented Oct 30, 2021

In order to eat our own dogfood and provide an always working example,
let's use Holocron as a tool for building its own documentation.

TODO

  • Extract changes to restructuredtext processor into separate PR.
    restructuredtext: generate #section references #268
  • Extract changes to tox.ini into separate PR.
    Bunch of changes in project infrastracture #269
  • Add Quickstart guide and section to navigation bar.
  • Document processors
    • jinja2
    • archive
    • chain
    • commonmark
    • feed
    • frontmatter
    • import_processors
    • markdown
    • metadata
    • pipe
    • prettyuri
    • restructuredtext
    • save
    • sitemap
    • source
    • todatetime
    • when
  • Custom processors-docs should render HTML in order to do not tie to restructuredtext.

@ikalnytskyi ikalnytskyi force-pushed the docs/holocron branch 3 times, most recently from 791c17b to 7e81888 Compare October 31, 2021 10:09
In order to eat our own dogfood and provide an always working example,
let's use Holocron as a tool for building its own documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant