Skip to content

Commit

Permalink
Add vitepress doc page
Browse files Browse the repository at this point in the history
I fixed the test-builds repo to work properly,
and this also links out to a user example repo, but I want to improve that probably with a logo.
  • Loading branch information
ericholscher committed Jan 22, 2025
1 parent 836cf22 commit 7d8be83
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/user/intro/doctools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,16 @@ Below is a list of popular documentation tools that you can use to write your do
Written in
:bdg-info:`rust`

.. grid-item-card:: VitePress
:link: vitepress.html

VitePress is a static site generator with a focus on performance and simplicity.

Supported formats
:bdg-success:`md`
Written in
:bdg-info:`javascript`

.. toctree::
:hidden:

Expand All @@ -73,3 +83,4 @@ Below is a list of popular documentation tools that you can use to write your do
/intro/docusaurus
/intro/markdoc
/intro/mdbook
/intro/vitepress
60 changes: 60 additions & 0 deletions docs/user/intro/vitepress.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
VitePress
=========

.. meta::
:description lang=en: Learn how to host VitePress documentation on Read the Docs.

`VitePress`_ is a static site generator with a focus on performance and simplicity.

Minimal configuration is required to build an existing VitePress project on Read the Docs.

.. code-block:: yaml
:caption: .readthedocs.yaml
version: 2
build:
os: ubuntu-lts-latest
tools:
nodejs: "latest"
jobs:
install:
- npm install vitepress
build:
# The site was created by running `vitepress init`
# and following the official guide
# https://vitepress.dev/guide/getting-started
- vitepress build docs
- mkdir -p $READTHEDOCS_OUTPUT/
- mv docs/.vitepress/dist $READTHEDOCS_OUTPUT/html
.. _VitePress: https://vitepress.dev/

.. button-link:: https://dbtoolsbundle.readthedocs.io/en/stable/

DbToolsBundle uses VitePress and Read the Docs

Getting started
---------------

- If you have an existing VitePress project you want to host on Read the Docs, check out our :doc:`/intro/add-project` guide.
- If you're new to VitePress, check out the official `Getting started with VitePress`_ guide.

.. _Getting started with VitePress: https://vitepress.vuejs.org/guide/getting-started.html


Example repository and demo
---------------------------

Example repository
https://github.com/readthedocs/test-builds/tree/vitepress

Demo
https://test-builds.readthedocs.io/en/vitepress/

Further reading
---------------

* `VitePress documentation`_

.. _VitePress documentation: https://vitepress.vuejs.org/

0 comments on commit 7d8be83

Please sign in to comment.