Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stuyk/athena-docs-latest

Athena Docs Vitepress Version
https://github.com/stuyk/athena-docs-latest

hacktoberfest

Last synced: about 22 hours ago
JSON representation

Athena Docs Vitepress Version

Awesome Lists containing this project

README

        

# alt:V Athena Documentation

Official documentation repository that utilizes vitepress, and used as the home page for `https://athenaframework.com/`.

## Viewing Docs Locally

Clone or fork this repository and then clone it.

Then navigate inside of it and run the following commands.

```
npm i
```

```
npm run dev
```

Open the documentation on [http://localhost:5173](http://localhost:5173).

## Contributions

Contributions to the documentation should be made in the form of pull requests.

Make a pull request with the documentation you want to add.

Ensure that any page that is changed has the following at the top:

```md
---
title: 'Page Title'
order: 0
---

# {{ $frontmatter.title }}

Content goes here...
```