Skip to content

Latest commit

 

History

History
122 lines (82 loc) · 5.33 KB

README.md

File metadata and controls

122 lines (82 loc) · 5.33 KB
Raw

Aplós

A sleek, contemporary, and purposefully designed VitePress theme

s

Important

If you want to see the documentation/guide check https://aplos.gxbs.me.

Screenshot of Aplos

Features

  • 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.
Repo Card

Name

The name 'Aplós', pronounced as /aplós/ is the Romanized representation of the Greek word 'Απλός,' which translates to 'Simple'. This naming choice showcases the essence of the project— it's dedication to providing users with a straightforward 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

You can install the package with the following command:

npm i aplos

You can check the next steps by looking at the Guide I made.

Know your rights

This project is under the MIT license:

  • Freedom to Use: You have the right to use the software for any purpose, whether it's personal, academic, or commercial.
  • Freedom to Modify: You can modify the source code of the software to suit your needs or preferences.
  • Freedom to Distribute: You have the right to distribute the software, whether in its original form or modified, to others.
  • Collaboration: You can collaborate with others on the software's development and improvement.
  • No License Compatibility Issues: You can combine the MIT-licensed software with other software, even if they use different licenses.
  • No Usage Restrictions: There are no restrictions on the technologies or fields of use, giving you maximum flexibility.
  • No Royalties: You are not required to pay any royalties or fees for using, modifying, or distributing the software.

Contributing

If you want to contribute to Aplós, you can check the Contributing page in the documentation, and you can also check the Code of Conduct to understand the rules and guidelines.

Release Cycle

Now that Aplós is an NPM Package, a release cycle is required. There is a new version every Saturday at 16:00 GMT for regular small updates (if there are changes), and for more critical updates every time there is a need.

Sometimes this schedule isn't followed, but it is the general rule.

Versioning

Aplós uses Semantic Versioning, so you can understand the changes by looking at the version number (using the major.minor.patch format).

It might be possible that the pre-release versions start as a patch version and end up becoming a minor/major version (e.g: 2.1.3-1 -> 2.2.0-0) if there are significant changes or breaking changes.

'Next' Tag

The 'next' tag is version of Aplós, used to test the next version before it is released. Use the 'next' tag if you want to test the next version of Aplós.

You can install the 'next' tag with the following command:

npm i aplos@next

Development

If you want to contribute to Aplós, make sure to fork the repository and cloned it with git clone or gh repo clone.

After cloning the repository, you can install the dependencies with the following command:

pnpm install

If you want a development server, you can directly run the Docs for development using the following command:

pnpm docs:dev

You can edit the project and see your changes live.

All other standard VitePress commands are available, like pnpm demo:build and pnpm demo:preview.

Note

Only the build and preview commands require the demo prefix.

Thanks ❤ & Credits️

  • 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.

Documentation

The documentation source is in the docs folder, it always uses the latest code from the main branch, so you can see the latest changes and use it as the development environment. If you happen to find any issues, please report them in the Issues section.