-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Update README to the actual project readme
Now that the package is the core of the project, it's the best time to migrate the main README here, rather then the docs repo
- Loading branch information
Showing
1 changed file
with
27 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,35 @@ | ||
| <div align="center"> | ||
| <h1>Aplós - NPM Package</h1> | ||
| Aplós, but just the theme files, as an NPM Package | ||
| <h1>Aplós</h1> | ||
|
|
||
| A sleek, contemporary, and purposefully designed VitePress theme | ||
| </div> | ||
|
|
||
| > [!IMPORTANT] | ||
| As I said above, this package is just for theme files. For the actual Aplós Project check [GabsEdits/aplos](https://github.com/GabsEdits/aplos) | ||
| This package containes all the files of the Aplós theme. For the actual documentation check https://aplos.gxbs.me | ||
|
|
||
| ## Usage | ||
| First, Init the Submodules: | ||
| ```sh | ||
| git submodule init | ||
| ``` | ||
|  | ||
|
|
||
| Then, add the theme to the `pages/.vitepress/theme` directory: | ||
| ```sh | ||
| git submodule add https://github.com/GabsEdits/aplos-theme.git pages/.vitepress/theme | ||
| ``` | ||
| ## Features | ||
|
|
||
| ### Update | ||
| To update the theme run this command: | ||
| - Lightweight and minimalistic, using VitePress. | ||
| - Elegantly styled with a primary color theme for a visually pleasing experience. | ||
| - Mobile-friendly design with support for dark mode. | ||
| - Optimized for social media sharing with meta cards. | ||
| - Utilizes premium fonts: Inter for text and Geist Mono for code snippets. | ||
| - Local development made easy with NPM/PNPM integration. | ||
|
|
||
| ```bash | ||
| git submodule update --remote --merge | ||
| ``` | ||
| ## Name | ||
|
|
||
| The name 'Aplós', pronounced as `/aplós/` is the Romanized representation of the Greek word 'Απλός,' which translates to 'Simple' or 'Pure and simple'. This naming choice that showcases the essence of the project— it's dedication to providing users with a traightforward and modern web experience. Aplós is centered around the philosophy of simplicity, aiming to deliver an uncomplicated and contemporary solution for website creation. | ||
|
|
||
| ## Try & Use | ||
|
|
||
| To try and use this project you can check the [Guide](https://aplos.gxbs.me/guide/) I made. | ||
|
|
||
| ## Thanks ❤ & Credits️: | ||
|
|
||
| - [Duckquill](https://daudix.codeberg.page/duckquill), from where I got inspired to create this project (and many ideas are from there) | ||
| - [Inter](https://rsms.me/inter/), used for all Sans Serif text. | ||
| - [Geist Mono](https://vercel.com/font/), used for code snippets. | ||
| - [VitePress](https://vitepress.dev), which is used to power Aplós. | ||
| - Everyone that supported the project. |