https://github.com/gabsedits/sencilla
https://github.com/gabsedits/sencilla
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gabsedits/sencilla
- Owner: GabsEdits
- License: mit
- Created: 2024-07-15T12:24:03.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T18:42:39.000Z (over 1 year ago)
- Last Synced: 2025-03-11T19:37:52.727Z (over 1 year ago)
- Language: Vue
- Size: 2.91 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Sencilla
A dead simple and minimalistic blog plugin for Aplós in VitePress.
## Features
- Elegantly styled with a primary color theme for a visually pleasing experience.
- Mobile-friendly design with support for dark mode.
- Utilizes premium fonts: Inter for text and Geist Mono for code snippets.
- Local development made easy with NPM/PNPM integration.
## Try & Use
You can install the package with the following command:
```bash
npm i sencilla
```
## Contributing
If you want to contribute to Sencila, you can check the [Contributing](https://aplos.gxbs.dev/contributing) page in the documentation.
## Release Cycle
Now that Sencilla is an NPM Package, a release cycle is required. There is a new version every Saturday at 16:10 GMT for regular small updates (if there are changes), and for more critical updates every time there is a need.
### Versioning
Aplós uses [Semantic Versioning](https://semver.org/), 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 Sencilla, 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:
```bash
npm i aplos@next
```
### Development
If you want to contribute to Sencila, you can clone the repository and install the dependencies with the following commands:
```bash
git clone https://github.com/aplosdev/aplos.git
```
Before you start developing, make sure to install the dependencies:
```bash
pnpm install
```
If you want a development server, you can directly run the Docs for development using the following command:
```bash
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️
- [Aplós](https://aplos.gxbs.dev), from who Sencilla is forked.
- [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.
---
## 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](https://github.com/aplosdev/aplos/issues) section.**