Skip to content

chore update docs a little #76

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.

Sign up for GitHub

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

Merged
amousavigourabi merged 1 commit into from
Jul 11, 2026
Merged

chore update docs a little #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# folio.md

[![CI](https://github.com/amousavigourabi/folio.md/actions/workflows/ci.yml/badge.svg)](https://github.com/amousavigourabi/folio.md/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Built with Astro](https://img.shields.io/badge/Built%20with-Astro-FF5D01?logo=astro&logoColor=white)](https://astro.build)
[![Powered by Bun](https://img.shields.io/badge/Powered%20by-Bun-fbf0df?logo=bun&logoColor=black)](https://bun.sh)

A zero-config documentation site builder powered by Astro, MDX, and Tailwind CSS. Add it as a dependency to your project, point it at your docs folder, and ship. No managed platform, no per-seat pricing, no lock-in.

**Docs:** https://foliopages.dev | **Repository:** https://github.com/amousavigourabi/folio.md | **Default branch:** `master`
Expand Down Expand Up @@ -60,17 +65,16 @@ Open [http://localhost:4321](http://localhost:4321) to view the site.

## Content

Docs live in `src/content/docs/` as `.mdx` files. Each file's frontmatter controls its title, nav icon, and sidebar order:
Docs live in `src/content/docs/` as `.mdx` files. Each file's frontmatter controls its title and nav icon:

```mdx
---
title: My Page
icon: House
order: 1
---
```

Available icons are defined in `src/components/NavIcon.tsx`.
Sidebar order is determined by numeric filename prefixes (e.g. `01.Introduction.mdx`, `02.Setup.mdx`). Available icons are defined in `src/components/NavIcon.tsx`.

## Project Structure

Expand Down