Comments (4)
I'm used to use mkdocs
and I think it's simple, powerful and beautiful.
You just need to use markdown in your doc files, and create an index file to give them a title and define a navigation menu. I'm currently using this docker image for this purpose: MKDocs Material.
In summary:
- I've a stack file with the definition of the docs of the site and I'm using it for CD of the docs.
docker-compose.docs.yml
version: "3.1"
networks:
docs-network:
services:
docs:
build:
context: .
dockerfile: ./docs/Dockerfile
image: REGISTRY/IMAGE:${PROJECT_DOCS_VERSION:-local}
networks:
- docs-network
deploy:
mode: replicated
resources:
limits:
cpus: '0.1'
memory: 64M
reservations:
cpus: '0.05'
memory: 16M
- For development I have an extended
docker-compose.docs.override.yml
file:
version: "3.1"
services:
docs:
volumes:
- ./docs:/docs/docs
- ./docs/mkdocs.yml:/docs/mkdocs.yml
ports:
- "8000:8000"
In my docs folder I have the Dockerfile
, the mkdocs.yml
and the Markdown files.
Dockerfile
FROM squidfunk/mkdocs-material:1.7.4
COPY ./docs /docs/docs
COPY ./docs/mkdocs.yml /docs/mkdocs.yml
mkdocs.yml
site_name: Doc Title
pages:
- Home: index.md
- Section1:
- Page1: page1-1.md
- Page2: page1-2.md
- Section2:
- Page1: page2-1.md
- Page2: page2-2.md
- Etc
repo_url: https://my-repo.address
edit_uri: src/master/docs/
site_author: It's me
copyright: Copyright © 2017 My Copyright
strict: true
theme: 'material'
extra:
palette:
primary: 'blue'
accent: 'light blue'
markdown_extensions:
- toc
- admonition
- codehilite(guess_lang=false)
- toc(permalink=true)
- footnotes
- pymdownx.arithmatex
- pymdownx.betterem(smart_enable=all)
- pymdownx.caret
- pymdownx.critic
- pymdownx.emoji:
emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist(custom_checkbox=true)
- pymdownx.tilde
- Another thing I do is to create a symbolic link in the project from the
docs/index.md
to theREADME.md
file to not to duplicate the initial project description.
All you need from here is just to play with some configuration options and integrate the deployment with your favourite tool for CD and map your deployed doc with the DNS you suggested orbiter.scaledocker.com
.
If you like this idea I could provide you more details.
from orbiter.
Hello @bvis thanks for your feedback. I know very well mkdoc and I agree it can be a good solution. I am concerned about the layout, colors and thinks like that!
from orbiter.
Why don't use the default colors? They are well balanced, once you see it's the right tool you could invest time on the colors, I think the default layout is good enough.
from orbiter.
If you want to manage this project with Ghost let me know, I'll be glad to host it.
from orbiter.
Related Issues (20)
- autoconfig refactoring.
- Autodetection swarm mode
- debug mode should allow pprof and other utils
- Make orbiter a swarm autoscaler
- scale up post cmd failure HOT 4
- Makefile improvements HOT 2
- Vendor out of sync HOT 1
- Use `sirupsen/logrus` instead of `Sirupsen/logrus` HOT 2
- Autoscaling destroy all previous container on first action HOT 4
- Remember that we are not in sync with `dep ensure` because of docker client lib HOT 1
- VirtualBox host-only adapters error HOT 1
- More documentation HOT 1
- Has this project been abandoned? HOT 1
- Optimize by querying by ID HOT 1
- executable file not found in $PATH HOT 4
- Service starts but not use the port that is specified
- No response from curl command with "direction=true/false"
- (bug) "exec format error" on Raspberry PI 3 & 4
- Any additional configuration required to make Orbiter autoscale? HOT 1
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 orbiter.