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.

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

docs: added sidebar for examples #32

Merged
merged 1 commit into from
Jun 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/docs/examples/Intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Examples
This section contains example usages of the Graaf library.
If there is a usecase you would like to see an example of, please open an issue in our [issue tracker](https://github.com/bobluppes/graaf/issues).
File renamed without changes.
6 changes: 6 additions & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ const config = {
position : 'left',
label : 'Tutorial',
},
{
type : 'docSidebar',
sidebarId : 'exampleSidebar',
position : 'left',
label : 'Examples',
},
{
href : 'https://github.com/bobluppes/graaf',
label : 'GitHub',
Expand Down
4 changes: 3 additions & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
tutorialSidebar : [ {type : 'autogenerated', dirName : 'tutorial'} ],

exampleSidebar : [ {type : 'autogenerated', dirName : 'examples'} ],

// But you can create a sidebar manually
/*
Expand Down