Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/semanticdata/dotfiles
⚙ Compilation of configuration files and other loosely related items.
https://github.com/semanticdata/dotfiles
alacritty alacritty-config dotfiles gitattributes-templates github-templates gitignore-templates hugo jekyll lua mpv mpv-config neovim neovim-dotfiles nvim nvim-dotfiles obsidian obsidian-md opinionated zola
Last synced: 15 days ago
JSON representation
⚙ Compilation of configuration files and other loosely related items.
- Host: GitHub
- URL: https://github.com/semanticdata/dotfiles
- Owner: semanticdata
- License: mit
- Created: 2023-09-05T18:35:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-05T15:01:55.000Z (7 months ago)
- Last Synced: 2024-11-17T11:37:22.131Z (3 months ago)
- Topics: alacritty, alacritty-config, dotfiles, gitattributes-templates, github-templates, gitignore-templates, hugo, jekyll, lua, mpv, mpv-config, neovim, neovim-dotfiles, nvim, nvim-dotfiles, obsidian, obsidian-md, opinionated, zola
- Language: CSS
- Homepage:
- Size: 73.9 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-template.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🎲 Project Name
> Short description of the project.
## 📑 Table of Contents
- [🎲 Project Name](#-project-name)
- [📑 Table of Contents](#-table-of-contents)
- [📄 Description](#-description)
- [🚀 Getting Started](#-getting-started)
- [⚙ Usage](#-usage)
- [🧪 Testing](#-testing)
- [Deployment](#deployment)
- [Useful Commands](#useful-commands)
- [🔌 Plugins](#-plugins)
- [Changelog](#changelog)
- [🗺 Roadmap](#-roadmap)
- [❤ Acknowledgments](#-acknowledgments)
- [© License](#-license)
## 📄 Description
Full description of the project:
- What is it about?
- What does it do?
- Why is it useful?
- What problem does it solve?
- Who is it for?
## 🚀 Getting Started
### Prerequisites
- You need this item
- And you need this item
- Oh, and don't forget this item
### Installation
## ⚙ Usage
Instructions for how to configure, run, and use the project. You can include the commands needed to install and start the development environment or any other useful and important commands. _Screenshots_ can be included as well.
Look for more information in the [Documentation].
## 🧪 Testing
- Any unit or integration tests people can run to assure that everything’s working as expected?
- Any frameworks or commands that are needed here?
- Are there any tests in your deployment pipeline that ensure that no errors make it into the live site?
Also include the commands needed to run any tests:
```sh
# Run test(s)
npm run test
```
## Deployment
Instructions for how to deploy the project to a production environment, including any server requirements and commands used. And, in case you are using a CI/CD pipeline, for example, how do any automated processes work? What are the most important branches? Do they trigger any pipelines?
[GitHub Pages]() - [Vercel]() - [Netlify]() - [Cloudflare Pages]()
## Useful Commands
```sh
# Install dependencies
npm install
# Update dependencies
npm update
# Start local dev server
npm start
# Check formatting w/ Prettier
npm run check
# Fix formatting w/ Prettier
npm run format
```
For more details take a look at [package.json](package.json).
## 🔌 Plugins
- Plugin 1
- Plugin 2
## Changelog
We use [Semantic Versioning](https://semver.org/) for releases.
- 0.1.0
- First release
- CHANGE: Rename `foo()` to `bar()`
- FIX: Crash when calling `pleasedonotcrash()`
- 0.0.1
- Initial commit
## 🗺 Roadmap
- [x] Completed Change 1
- [x] Completed Change 2
- [ ] Incomplete Roadmap Item 1
- [ ] Incomplete Roadmap Item 2
## ❤ Acknowledgments
Thanks to these amazing people and their projects:
- [Person] – [Website]
- [Project] - [Website]
## © License
This code is available under the [MIT License](LICENSE).