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.

Sign up for GitHub

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

Jump to bottom

Consider .adoc extension #11

Open

tomschr opened this issue Jul 29, 2020 · 0 comments

tomschr commented Jul 29, 2020 •

edited

Loading

Situation

Currently, all the source files end with .txt.

Suggestion

Why not use .adoc as a file extension? This has some benefits:

Small change, big impact.
GitHub renders .adoc automatically when you open them on their web site.
Easier to read than the raw source code.
Supports your readers, they don't have to build the book.

Of course it won't be perfect, but nobody expects that. 😉

Example

https://github.com/SUSE/doc-susemanager/blob/master/modules/administration/pages/icinga.adoc

The text was updated successfully, but these errors were encountered:

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