Docsphere Reader

"Streamline your documentation process with Docsphere."

Introducing Docsphere, the ultimate documentation system for all your needs. With a user-friendly interface and a range of features, Docsphere makes it easy to create and manage your documentation with subpages:

The "Overview" subpage provides a comprehensive introduction to your documentation, allowing you to showcase the key features and benefits of your project. Use this page to highlight the most important information about your project and explain its purpose and goals. With the "Samples" subpage, you can easily demonstrate how your project works in real-world scenarios. Show off your project's capabilities by creating sample use cases that highlight its most powerful features. Finally, the "Vs" subpage allows you to compare your project with other technologies and competitors in your industry. Use this page to show why your project is superior and how it can benefit users in ways that other products can't.

Overall, Docsphere is the perfect solution for anyone who needs to create high-quality documentation quickly and easily. Whether you're a software developer, product manager, or technical writer, Docsphere has everything you need to create effective and engaging documentation for your project.

You can clone this repository, run on a web server and have access to everything completely offline on your computer! You can also compile for mobile and desktop devices.

Some others features of this documentation system are listed below! See the projects tab for more details!

Compliances

Contrast Checker 7+

The World Wide Web Consortium (W3C) has developed the Web Content Accessibility Guidelines, better known as WCAG, for color contrast and text. People who are color blind and have impaired vision can experience sensitivity and often physical pain to certain colors and shades of light. (Read more)

Features

Internationalization with i18n

We want the documentation to be available in any language so that it can reach everyone.

Menu search engine based in i18n content

The search for content in the documentation is simple, fast and easy. The search input text in the menu makes it easy to search for any content (headers, paragraphs, source codes) and you can do it in your favorite language. If the defined language is not English and if the search term is not found or has not been set in current language, by default a search is still performed using keywords in English.

Source code highlighted

This documentation generates codes with Syntax highlighting from texts with multiline and line indented stored in i18n files. So you can access the codes of the documentation offline and we can also use i18n for example to translate code comments.

Navigation using anchored links

Anchor links work in hash and history mode and provide faster navigation and better orientation when navigating through subsections of documentation.

Contributing

Wait for the CONTRIBUTING.md file to initiate a contribution to this repository.

License

Copyright (c) 2018-Present - Rodrigo Vieira ([email protected])

MIT License