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

docs: Move docs to MkDocs #7497

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

Neko-vecter
Copy link

@Neko-vecter Neko-vecter commented Nov 16, 2024

Description

This pull request is move current docs and some improvements to MkDocs.

What in this pull request?

  • It can be deployed on GitHub Pages.
  • Better document translation and localization (it easier translation and localization to other languages)
  • Easier to navigate and search
  • Better document structure (find things much easier)

Screenshots/Recordings/Graphs

image image

Build the docs

It able build using docker by using command below

# clone from the fork 
git clone https://github.com/Neko-vecter/OrcaSlicer.git
cd ~/OrcaSlicer
docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build

The build site in site folder.

Current progress

The action still in progress. (Testing now...)

Also the common issue I still being collected and organized.

-Neko.vecter

@igiannakas
Copy link
Contributor

igiannakas commented Nov 20, 2024

Amazing! Finally a nice way to visually represent the wiki!

@Neko-vecter
Copy link
Author

@igiannakas Thanks! I am still working on the common issue.

As you mentioned earlier.
The publish_docs_to_wiki.yml is the action push doc folder to the GitHub repo wiki. The build for gh-pages I am still working on it also testing.

After finished new action workflows for the gh-pages I will open a new pull request to remove the old doc and add new workflows to the action.

-Neko.vecter

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants