Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 1.74 KB

LEARN.md

File metadata and controls

63 lines (39 loc) · 1.74 KB

Aplós - LEARN.md

A sleek, contemporary, and purposefully designed VitePress theme & template. It provides a straightforward solution for creating a quick web page, offering essential features for comfortable writing while maintaining a sense of simplicity.

Prerequisites

Ensure that Node and NPM/PNPM are installed on your machine.

Installation

Clone the repository using the following command:

git clone https://github.com/aplosdev/aplos.git

Make sure to have PNPM (or NPM) installed, then install dependencies:

pnpm install

To run a development server, use:

pnpm run docs:dev

To build the project run:

pnpm run docs:build

Configuration & Usage

Refer to the documentation at https://aplos.gxbs.dev/guide/ for detailed information on configuration and usage.

Contributing

If you wish to enhance Aplós, feel free to open an issue or, even better, submit a pull request. I appreciate every contribution!

License

The project is licensed under The MIT License

Resources

Acknowledgements

  • Duckquill, from where I got inspired to create this project (and many ideas are from there)
  • Hari Rana for style-related feedback and suggestions
  • Inter, used for all Sans Serif text.
  • Geist Mono, used for all monospaced text.
  • VitePress, which is used to power Aplós.
  • Everyone that supported the project.

Contact

In case of anything please contact me through Email or any of the links provided here