search

Linbreux / wikmd

A file based wiki that uses markdown
https://linbreux.github.io/wikmd/
MIT License
343 stars 38 forks source link

NavBar #78

Open adamwojt opened 2 years ago

adamwojt commented 2 years ago

I am really missing sticky NavBar on the left for this library. i think it might be bit different request than https://github.com/Linbreux/wikmd/issues/51 Virtually all docs have this.

image image image

Linbreux commented 2 years ago

Hi @adamwojt, What kind of navbar do you mean? A table of contents of the current page? We are currently working of a [[toc]] macro, there are also plans to create a sidebar. https://github.com/Linbreux/wikmd/discussions/70#discussioncomment-3614896

adamwojt commented 2 years ago

@Linbreux The sidebar on the left. I guess it's a dupe then. I thought that the macro issue is bit different than that.

Linbreux commented 2 years ago

@adamwojt The sidebar is on the TODO list ;) We just need to find a good way to integrate it. I'll notify you when we are there!

skjerns commented 1 year ago

Is this still on the "not planned" list?

I think a sidebar would be really useful feature!

Linbreux commented 1 year ago

Hi @skjerns, I am currently working on this. For now I'm thinking of something like the image bellow: image

On the left a customizable sidebar, maybe a yaml or something. On the right a table of contents.

Suggestions or PR's :) are always welcome.

Jerakin commented 8 months ago

I have started on this. How does something like this look?

I think that having practically having the whole folder structure would be the best. Then on the right side we could add the table of content like in Linbreux example above.

https://github.com/Linbreux/wikmd/assets/5273682/a5e1c352-a5c4-4eb7-b874-8c8dfdd7707d

Linbreux commented 8 months ago

@Jerakin This looks clean! Keep in mind that a bunch of people have a lot of files in there root folder (50+).

Jerakin commented 8 months ago

Yeah, if there is a lot of files there will be a scrollbar image

Jerakin commented 8 months ago

I was thinking that it would be really cool that if you had a structure like this 

wiki/
├─ gummi/
│  ├─ cupcake.md
│  ├─ fruitcake.md
├─ gummi.md
├─ how to use the wiki.md

The the gummi.md file wouldn't show up in the list but rather it would be rendered if you pressed the gummi folder. This would require a bit of change though as currently you can press anywhere on the folder name to expand it, if we added that functionality you would need to press on the arrow only to expand it.

Meaning the menu would be rendered without the gummi.md but the folder would the page for it.

wiki/
├─ gummi/
│  ├─ cupcake.md
│  ├─ fruitcake.md
├─ how to use the wiki.md