rust-lang / rust-lang/mdBook

How do you retrofit a third-party wiki with Git, that has been git cloned locally, into mdbook compatible format?

Open
#2,352 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-question
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Question

Hello

I am using Termux and Zsh is my login and default shell, and my daily driver. I searched through the mdbook documentation, and I couldn't find what I was looking for. So, I felt I would ask.

How do you retrofit a third-party wiki with Git, that has been git cloned locally, into mdbook compatible format? Is it possible?

I understand that if it is possible, the wiki would need to be initialised, and a SUMMARY.md file would needsmust, be generated. Must these processes be done manually? Or is retrofitting automation possible, for an already established third-party wiki with Git?

Any assistance greatly appreciated.

Thanking you in anticipation
Beauford

Version
mdbook v0.4.37

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the mdBook documentation for importing an existing Git-cloned wiki, starting with SUMMARY.md and the mdBook v0.4.37 behavior. Clarify whether the requested outcome is manual setup or automation; done would require a documented, reproducible conversion path, but the issue does not identify files or tests to change.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, markdown, rust, zsh
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.