kazzkiq / herodotus Goto Github PK

Today users have to CTRL+F to search for terms in documentation. They should be able to find it easily through a search input for terms, headings, and snippets.

Example: https://docs.snipaste.com/

Add possibility of document translation support based on user locale.

This feature should be able to:

• Generate a dropdown letting user choose language;
• Detect user lang automatically and load documentation file accordingly.

The idea here is that when writing docs, users would separate langs per folders, like:

/app/assets/docs/
|-en/
   |-documentation.md
|-es/
   |-documentation.md
|-pt/
   |-documentation.md

Then, when generated, the documentation would adopt the name of its parent folder, like such:

/app/public/
|-documentation.md
|-documentation-es.md
|-documentation-pt.md

Notice that, as english is the default language, the english file remains documentation.md.

This is a Feature Request

All the headings in the documentation should be links. Those links then should be able to open at the exact scroll position where the heading is at.

Example of possible URLs:

https://mydoc123.com/documentation/#/heading-1
https://mydoc123.com/documentation/#/section/heading-1
https://mydoc123.com/documentation/#?heading-1

Would be very interesting to have touch gestures (swipe-left/right) to open and close menus in mobile the mobile version.