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

Upgrade doc #5

Merged
merged 3 commits into from
Sep 20, 2024
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
2 changes: 2 additions & 0 deletions doc/blog/2024-07-21-welcome/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ tags: [hello]

Welcome! I've embarked on an exciting journey to explore how Docusaurus can be used to document OCaml projects, while seamlessly integrating with OCaml's dedicated tools like dune, odoc, and ocaml-mdx.

<!-- truncate -->

This exploration aims to culminate in a template or a simple example that showcases the dynamic capabilities of combining these tools. It's a work in progress, and I'm eager to dive deeper into the features, seeking to enrich this experiment with community feedback and collaboration.

I'm thrilled to have initiated this repository, creating a space for incremental progress and sharing insights with fellow Docusaurus and OCaml enthusiasts.
Expand Down
3 changes: 3 additions & 0 deletions doc/docs/explanation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Explanation

Welcome to the Explanation section of the documentation. Here, we delve into the details of how the project works, its design principles, and our future plans. This section is intended to provide a deeper understanding of the project for developers and contributors.
3 changes: 3 additions & 0 deletions doc/docs/guides/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Introduction

This part of the documentation is currently empty.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
38 changes: 29 additions & 9 deletions doc/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,17 +73,29 @@ const config: Config = {
items: [
{
type: 'docSidebar',
sidebarId: 'odocSidebar',
sidebarId: 'tutorialsSidebar',
position: 'left',
label: 'OCaml Packages',
label: 'Tutorials',
},
{
type: 'docSidebar',
sidebarId: 'mylibSidebar',
sidebarId: 'guidesSidebar',
position: 'left',
label: 'Mylib',
label: 'Guides',
},
{ to: '/blog/', label: 'Blog', position: 'left' },
{
type: 'docSidebar',
sidebarId: 'referenceSidebar',
position: 'left',
label: 'Reference',
},
{
type: 'docSidebar',
sidebarId: 'explanationSidebar',
position: 'left',
label: 'Explanation',
},
{ to: '/blog/', label: 'Blog', position: 'right' },
{
href: 'https://github.com/mbarbin/doc-experiment-docusaurus',
label: 'GitHub',
Expand All @@ -104,12 +116,20 @@ const config: Config = {
title: 'Docs',
items: [
{
label: 'OCaml Packages',
to: '/docs/odoc/',
label: 'Tutorials',
to: '/docs/tutorials/hello-mylib/',
},
{
label: 'Guides',
to: '/docs/guides/',
},
{
label: 'Reference',
to: '/docs/reference/odoc/',
},
{
label: 'Mylib',
to: '/docs/mylib/hello_mylib/',
label: 'Explanation',
to: '/docs/explanation/',
},
],
},
Expand Down
Loading