Comments (2)
Technical features to consider
- Theme
- Right-side local TOC
- Dark Mode
- Sphinx
- Auto-generate the documentation by importing readme's at build time
- Auto-generate the API documentation and Classes
- Tabs for content including OS-specific topics or to help convey the story
- Material Design
- Sitemap.xml submissions so Bing and Google know you exist
- Meta information in each header so crawlers know the content
- Auto-generation of multiple languages
from lux-design-s1.
Useful technical links for documentation
I recently created a few hundred pages on ReadTheDocs
Kinda a grab bag of every extension that does something mildly interesting. Tech stack for the site
General Computer Setup is pretty good. Advanced Computer Topics is interesting but it's an endless topic.
I stopped adding more pages because there were so many features I wanted to add and actually the whole thing needed to be automated - otherwise things get out of date and technical debt builds up. Without the right meta in headers people don't know the pages exist, so meta needs to be correct and auto generated and sitemaps sent to the search engines automatically upon changes. So for my needs I need automation, and the scale of this project would reward automation where possible.
I include some links here as they may be useful resources:
- Right-hand TOC
- Dark Mode - Change the colors of the Sphinx Read The Docs theme
- SEO learning resources
- Sphinx-copybutton - add a little “copy” button to the right of your code blocks
- Nicer looking tabs, show/hide blocks of text using sphinx extension sphinxcontrib-contentui
- readthedocs-embed Allows users to embed HTML documentation from any Read the Docs project
- Use templates
- Sphinx Gitstamp Generator Extension
- sphinx-git allows you to include excerpts from your git history within your documentation
- sphinxcontrib-mermaid - lets you create diagrams and visualizations using text and code
- Custom Google Analytics Reports and Alerts That Every Website Should Have
- mkdocs Material theme - right hand TOC, Material Design, dark mode
from lux-design-s1.
Related Issues (20)
- Node error when running Python agent HOT 18
- CLI on Macos does not have write permissions HOT 8
- ERR_REQUIRE_ESM: CLI don't works on Mac OS X HOT 2
- Visualiser version incompatibility HOT 1
- Please proof-read the Doc on the Website HOT 3
- Provide a kaggle notebook for compiling C++ (or other) agents
- fix kits/README.md
- Kaggle failed when main.py is changed HOT 2
- List of things that could have been done better and new features HOT 4
- Question about resource collection mechanics of a CityTile HOT 5
- citytile of cell class not initialized.
- the problem of mutual inclusion in kits/cpp
- Type Hints in main.py throwing a SyntaxError HOT 3
- annotate.text() in starter kits has wrong parameter order HOT 1
- Adding support for the Julia language HOT 27
- Adding Rust support HOT 1
- Support for FSharp language HOT 1
- npm install unsuccessful on windows WLS2 HOT 1
- Rust's `can_build` function for the worker unit seems to be wrong HOT 3
- Build C++ starter kit
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from lux-design-s1.