Skip to content

Comments

Docs/vitepress docs#1805

Draft
adithyaappu wants to merge 12 commits intofrappe:mainfrom
adithyaappu:docs/vitepress-docs
Draft

Docs/vitepress docs#1805
adithyaappu wants to merge 12 commits intofrappe:mainfrom
adithyaappu:docs/vitepress-docs

Conversation

@adithyaappu
Copy link

@adithyaappu adithyaappu commented Feb 6, 2026

VitePress Based Documentation Website

Based on #1760

This pull request makes a static website using VitePress and publish using GitHub pages.

Preview

https://adithyaappu.github.io/frappe_docker/

Summary of Changes

  1. Documentation and VitePress config are contained inside the docs/.
  2. VitePress is JavaScript based project, hence a pacakge.json, and lock file for pnpm, a package manager, is also added.
  3. md files need a YAML frontmatter / metadata for configuring them in sidebar. All the required frontmatter is added in current files
  4. A GitHub actions workflow for building and publishing the changes is added.
  5. VitePress specific entries in .gitignore
  6. Fixed dead links in various .md files
  7. index.md file controlling the home / landing page

Benefits of VitePress

  1. People can contribute to docs just by adding MarkDown files. No JavaScript knowledge is needed.
  2. Automated sidebar population. (YAML frontmatter is highly recommended)
  3. Browser based local search
  4. Sidebar navigation, and TOC in each page
  5. Dead link detection while building.
  6. Dark and Bright theme support out of the box.

To Do

  • Update the contribution guide.
  • Merging the Comprehensive Getting Started guide added by @duthink into current folder structure.
  • Setting up repo for GitHub pages publication. (Finalise the base URL)

Based on comments from #1760

  • Add section for FAQ
  • Easy Install Setup guide
  • @revant I did not understand what you mean by this. Did you mean have support for a tool like Mermaid?

https://adithyaappu.github.io/frappe_docker/getting-started.html#how-to-use-this-guide if diagrams are used they are not rendered as images.

Feedback

  1. @Rocket-Quack can you please check and ensure I did not accidentally reverted any recent changes? I have cross checked multiple times, but just wanted to be sure.
  2. @DanielRadlAMR @asieftejani let me know if any improvement is needed.

adithya added 12 commits February 6, 2026 23:02
VitePress is configured in the repo for handling docs
fix: pnpm Actions fix, corrected base

fix: Build error fixes

fix: Images not showing up in pages

fix: Moved logo to public path
The package.json and pnpm-lock.yaml are not part of the main repo but
specific to the docs. The workflow will now target this folder for
running.
moved public folder to docs.
Properly source the sidebar links
For creating pull request
Refactor can be considered later if needed.
Header in TLS / SSL setup was accidentally reverted to older one. Now
replaced with the new one.
New files didn't have YAML metadata, it is added now.
The README.md gives a brief overview about how to contribute to
documentation, and more detailed isntructions specific to VitePress is
added as a new page under References.
@adithyaappu adithyaappu marked this pull request as draft February 10, 2026 04:50
@Rocket-Quack
Copy link
Contributor

LGTM :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants