Giter Site home page Giter Site logo

acrobit / docusaurus-plugin-auto-sidebars Goto Github PK

View Code? Open in Web Editor NEW
21.0 21.0 5.0 490 KB

A docusaurus plugin that generates the sidebar items automatically by filesystem structure

JavaScript 46.30% TypeScript 44.32% CSS 9.39%
docusaurus docusaurus2 generator markdown plugin sidebar sidebars static-site static-site-generator

docusaurus-plugin-auto-sidebars's People

Contributors

cjoy avatar ghominejad avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

docusaurus-plugin-auto-sidebars's Issues

add links to sidebar

hey, small feature request :)

would it be possible to let people define items as href links in the sidebar? this is possible with the default sidebar and would be super useful with the auto sidebar!

perhaps let people define them in the yaml? or even a seperate yaml. something where u could also define what folder they would be in, along with the label. maybe something like:

- folder1:
   - links:
       - ExampleSite: https://example.com
       - Google: https://google.com
   - subfolder1:
       - links:
           - Github: https://github.com

anyway just thought this might be a handy little feature ๐Ÿ‘

Option to reverse order of Sidebar elements?

Thanks for making this.

Would it be possible to add an option to reverse the order of elements on the Sidebar?

I've been naming my documents by date, but that means that the Sidebar displays everything in reverse chronological order.

Seems to import folders not in sidebars.yaml

I have a folder that I don't want to include in the sidebar, but the plugin seems to be including that as well, even if it isn't included in the sidebars.yaml file :(

Unrelated side note - I think the docs are wrong for specifying the custom path. It says docs in the readme, but when I looked at the code, you're using path.

Is there a way to order files and folders?

  1. At the root level, I would like to move an Introduction page to above the first folder.
  2. My root level folders are all ordered correctly (Works well)
  3. My sub-folders are not ordered in the way I would like them.
  4. I would also like to put another intro.md file as the first entry

Is any of this possible in the current implementation, I have scoured the example and docs but haven't been able to find anything.

Btw, very nice plugin.

This is my sidebars file - it doesn't throw an error.
image

This is the result. The arrows are where I am trying to get the files to show up (#1 & 4), the order of level 2 is alphabetical, not as in the sidebars.yml
image

Thanks

Deeper sorting of filenames

Hi !
Now your sorting works like this:
docusaurus-veiw-sorting

The algorithm is good for sorting by the first numbers in the filename.
But the second numbers (if any) are sorted without taking into account the value of the number.

Is it possible to sort filenames deeper?

auto-sidebar-sorting

Thanks!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.