Bulk Markdown file import for Feather Wiki #29

Open
opened 4 months ago by ard · 5 comments
ard commented 4 months ago

I have a user guides written in markdown. How to convert that into feather wiki file?

thanks

I have a user guides written in markdown. How to convert that into feather wiki file? thanks

FeatherWiki uses a subset of markdown via the snarkdown lib.

Use the following tool:

https://snarky.surge.sh/

Paste your markdown and see if it displays correct on right panel. If that is case all good. Else try to tweak markdown to make it display correct on right panel.

If all is good, download the Dove or Chickadee versions of Featherwiki and create Pages and paste your markdown in markdown editor.

Ofcourse you can skip testing on snarky.surge.sh and directly paste in FeatherWiki markdown editor and check if results are good.

FeatherWiki uses a subset of markdown via the snarkdown lib. Use the following tool: https://snarky.surge.sh/ Paste your markdown and see if it displays correct on right panel. If that is case all good. Else try to tweak markdown to make it display correct on right panel. If all is good, download the Dove or Chickadee versions of Featherwiki and create Pages and paste your markdown in markdown editor. Ofcourse you can skip testing on snarky.surge.sh and directly paste in FeatherWiki markdown editor and check if results are good.
Poster

Thank you for your response. What I mean is someting like command line tool to automate this process and generate the final html file or inject those files to an existing wiki. So I just point to a directory of markdown files and run thatcommand to produce a final feather wiki file without manually copy-paste those files.

Thank you for your response. What I mean is someting like command line tool to automate this process and generate the final html file or inject those files to an existing wiki. So I just point to a directory of markdown files and run thatcommand to produce a final feather wiki file without manually copy-paste those files.

There is no tool yet. You may add a suggestion as a new issue.

There is no tool yet. You may add a suggestion as a new issue.
Alamantus added the
extension
request
labels 4 months ago
Owner

@ard

So I just point to a directory of markdown files and run thatcommand to produce a final feather wiki file without manually copy-paste those files.

I could make an extension to handle this... There will need to be some kind of flag for extra non-content data like title. I could imagine this either being the first H1 (#) or something like simple front matter like how Hugo or Jekyll handle it (preferably in JSON but I could probably do YAML if necessary).

Do your markdown files consistently have something like one of these already, or would you need to add either an H1 at the start or front matter to them?

@ard > So I just point to a directory of markdown files and run thatcommand to produce a final feather wiki file without manually copy-paste those files. I could make an extension to handle this... There will need to be some kind of flag for extra non-content data like title. I could imagine this either being the first H1 (`#`) or something like simple front matter like how [Hugo](https://gohugo.io/content-management/front-matter/) or [Jekyll](https://jekyllrb.com/docs/front-matter/) handle it (preferably in JSON but I could probably do YAML if necessary). Do your markdown files consistently have something like one of these already, or would you need to add either an H1 at the start or front matter to them?
Poster

Wow great, it would be helpful to generate single file HTML for user-guides/documentations. Yes, there is YAML frontmatter in my markdown files and also sometime there are few html tags.

Wow great, it would be helpful to generate single file HTML for user-guides/documentations. Yes, there is YAML frontmatter in my markdown files and also sometime there are few html tags.
Alamantus changed title from Convert bunch of markdown files into feather wiki to Bulk Markdown file import for Feather Wiki 4 months ago
Sign in to join this conversation.
No Milestone
No Assignees
3 Participants
Notifications
Due Date

No due date set.

Reference: Alamantus/FeatherWiki#29
Loading…
There is no content yet.