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.

Sign up for GitHub

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

Jump to bottom

SPIKE: Look into HackMD / MkDocs Integration for Knowledge Base #163

Closed
endurance opened this issue Jul 16, 2022 · 4 comments · Fixed by #212
Closed

SPIKE: Look into HackMD / MkDocs Integration for Knowledge Base #163

endurance opened this issue Jul 16, 2022 · 4 comments · Fixed by #212
Assignees
@jonmatthis
Milestone
00 Repo Setup and...

Comments

@endurance
Copy link
Collaborator

endurance commented Jul 16, 2022 •
edited by jonmatthis

Workflow:

  1. Use mkdocs to create our knowledge base skin
  2. Use HackMd with MkDocs configuration protocols to write KB articles

Notes:
https://www.mkdocs.org/getting-started/

PR #212
@endurance endurance added this to the Repo Setup and Cleanup milestone Jul 16, 2022
@jonmatthis
Copy link
Member

https://docs.google.com/presentation/d/1Xk15eYjGnGjuUlPOJgSoF2z5fhktZXMHNP_00blWi_s/edit#slide=id.gac39de1498_0_410

@jonmatthis
Copy link
Member

I've played with the hackMD/Github method and honestly it's pretty dang cool

I'm going to get started some proof-of-concept kinda docs using mkdocs and specifically this 'material-mkdocs' theme:
https://squidfunk.github.io/mkdocs-material/getting-started/

@jonmatthis jonmatthis mentioned this issue Jul 24, 2022
Open
@jonmatthis
Copy link
Member

PR #212

@jonmatthis
Copy link
Member

#212

@jonmatthis jonmatthis mentioned this issue Jul 24, 2022
Merged
@jonmatthis jonmatthis self-assigned this Jul 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jonmatthis jonmatthis

Labels
None yet
Projects
[OLD] Freemocap Main Backlog
Status: 👀 In review
Milestone
00 Repo Setup and Cleanup
Development

Successfully merging a pull request may close this issue.

Start building Knowledge Base with mkdocs freemocap/freemocap
2 participants
@endurance @jonmatthis