What is Astro Just Docs?

Astro Just Docs is a flexible, MDX-based authoring framework that allows you to put the focus on writing documentation, while giving you powerful styling options. It has a number of built in styled components, and is built on Tailwind CSS to be as extensible as possible.

Getting Started

Dependencies

Astro Just Docs is built for Astro, a static site generator. Astro Just Docs requires no additional setup beyond what’s normally expected when setting up an Astro website. For more details into how Astro works, check out their getting started guide.

Running Locally

Running Astro Just Docs isnt any different then any other Astro based site, and can be up and running in just a few commands. To get setDefaultResultOrder, clone the repository and run the following commands to install the dependencies and start the development server:

1
git clone git@github.com:underlost/astro-just-docs.git
2
cd astro-just-docs
3
yarn install
4
yarn dev

Production

Astro Just Docs is a static website and can be hosted just about anywhere. It has also been tested to run on Netlify, Vercel and AWS S3.

To build a production-ready build of the site to upload somewhere, run:

1
yarn build

This will create a dist folder with all the files needed to host the site.

Configuring

Astro Just Docs has a number of helpful settings. Refer to the configuration section for all options available.

About the project

Astro Just Docs is © 2024 by Tyler Rilling. It was originally created with GatsbyJS, and was inspired by Just the Docs, a Jekyll theme. It was rewritten in Astro to take advantage of the speed and flexibility of the framework.

Contributing

Contributions and feedback are welcome and encouraged. Check out our contributing guidelines on how to do so.