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

Move to markdown #16

Open
dyspose opened this issue Feb 26, 2024 · 1 comment
Open

Move to markdown #16

dyspose opened this issue Feb 26, 2024 · 1 comment
Assignees

Comments

@dyspose
Copy link

dyspose commented Feb 26, 2024

Move the docs to markdown (probably mkdocs material). And merge language branches into a single one.

In simple: Ge at rid of RTFD.

If @Vladislav4KZ isn't aginst, of course.

@dyspose dyspose self-assigned this Feb 26, 2024
@Vladislav4KZ
Copy link
Collaborator

What are the advantages that will come from this?

Read the Docs allows you to download documentation for offline reading in htmlzip-archive, pdf and epub formats.

Also it supports both reStructuredText and Markdown (but currently reStructuredText is used).

I once thought that maybe I should make the localization separate from the documentation files, so as not to duplicate images, configuration files, etc. in another branch.

Although some images are also different depending on the documentation language (images with text), and they can't seem to be replaced via Gettext (i.e. via localization files with .po extension)

And now I don't have time to do it, so I'm updating/editing what I have.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants