Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexisl61/ensiref
Les petites références pour les infos de l'ensi
https://github.com/alexisl61/ensiref
Last synced: 22 days ago
JSON representation
Les petites références pour les infos de l'ensi
- Host: GitHub
- URL: https://github.com/alexisl61/ensiref
- Owner: AlexisL61
- License: mit
- Created: 2023-06-11T13:57:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-06T18:21:33.000Z (about 1 year ago)
- Last Synced: 2024-05-02T05:09:21.998Z (8 months ago)
- Language: EJS
- Size: 33.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 📖 EnsiRef - Les références de cours pour les Ensicaennais
Le code de ce repository est repris de QuickRef.me
## 🗂️ Directory structure
```
.
├── source
│ ├── _posts # Cheat sheet source files
│ │ ├── algorithmique-avance
│ │ ├── ...
│ └── widget # Widget files
│ └── chmod.html
├── public # Distribution files
├── _config.yml
├── gulpfile.js
├── package.json
├── postcss.config.js
├── tailwind.config.js
└── themes
└── coo # Theme files
```
## 🤝 Contributing
1. Clone Github repo `git clone https://github.com/AlexisL61/EnsiRef.git`
2. Install `npm` package manager (Read [installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm))
3. Run `npm install` in the root folder to install dependencies.
4. Run `npm run dev` to start a dev server. This serves the project and live reloads when any files are changed, then visit http://127.0.0.1:4000 preview.
5. Submit a pull request and wait for it to be reviewed and merged.
To create or edit a cheat sheet, you'll need to create or edit a markdown file in `source/_posts/{filename}.md`. The file should include a front matter section with the following format:
```markdown
---
title: QuickRef
date: 2020-11-25 18:28:43
icon: icon-style
background: bg-emerald-600
tags:
categories:
- Other
intro: This is a reference of styles that you can use on quickref cheat sheets!
---
```
Only the `title` and `intro` fields are required, and the other options can be left blank.