Comments (3)
Material for MkDocs suggests using mike. This is a reasonable approach and should work with our current website deployment workflow (in github pages) but it might involve one extra step in the release process for Acquire.
from acquire-docs.
Ok, here's a proof of concept using mike as described above: https://melissawm.github.io/acquire-docs
The 0.3.0 and dev versions are exactly the same, this is mostly to show how the dropdown would look and the basic functionality (keeping the same page across versions etc) For example, if you go to https://melissawm.github.io/acquire-docs/dev/tutorials/trigger/ and change the version to 0.3.0, this will redirect to https://melissawm.github.io/acquire-docs/0.3.0/tutorials/trigger/
Please let me know if this looks reasonable, and maybe we need design to decide on the switcher? I went with a minimalistic look to match the rest of the theme. Note that the link above is my own personal fork; when we have decided on the look and feel I can submit a PR to this repo.
from acquire-docs.
I synced with Janeece about this, and using a dropdown with the browser-default styling is appropriate in this case, so we can move forward with implementing, @melissawm
from acquire-docs.
Related Issues (20)
- Link python files to tutorials HOT 3
- Copy for the website HOT 3
- Header as you scroll site pages
- Note admonition formatting and navigation TOC
- Logos in the header are broken HOT 3
- Prepare documentation for internal review
- Drivers.md tutorial is broken HOT 2
- Reflect changes to chunking API in release 0.2.0
- Make Acquire Docs header clickable
- Assets are missing
- `contribution/for_contributors.md.` is misnamed
- Docs Contributor QuickStart Not rendering
- Homepage cards not rendering properly HOT 2
- Landing page does not look good on mobile
- Documentation Content Additions H1 2024 Running List
- Add Anchor Links
- Tutorial Organization
- API reference autogeneration HOT 1
- livestream tutorial download broken. HOT 3
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 acquire-docs.