Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mkdocs Documentation POC [WIP] #4151

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Mkdocs Documentation POC [WIP] #4151

wants to merge 4 commits into from

Conversation

Himangini
Copy link
Contributor

NOTE - THIS IS WIP. No CONTENT was modified

POC for GitOps documentation built with Mkdocs [Material Theme]

For full documentation visit mkdocs.org and Material theme for mkdocs.

Follow the installation instructions here Getting Started.

Todo

  • Add versioning
  • Migrate landing page
  • Clean up Codeblock and BrowserOnly sections
  • Add deployment/docs publishing workflows

Commands

cd userdocs

  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

Under the folder userdocs

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Sample Output

$ mkdocs build
INFO     -  Cleaning site directory
INFO     -  Building documentation to directory: /Users/himangini/Documents/GitHub/weave-gitops/userdocs/site
INFO     -  Documentation built in 15.98 seconds

$ mkdocs serve
INFO     -  Building documentation...
INFO     -  Cleaning site directory
INFO     -  Documentation built in 18.55 seconds
INFO     -  [15:09:27] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO     -  [15:09:27] Serving on http://127.0.0.1:8000/

Screenshots

Screenshot 2023-11-29 at 14 09 22
Screenshot 2023-11-29 at 14 08 46
Screenshot 2023-11-29 at 14 05 38
Screenshot 2023-11-29 at 14 05 04
Screenshot 2023-11-29 at 14 04 19

@Himangini Himangini added the documentation Improvements or additions to documentation label Nov 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants