Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arnaudjuracek/cahier
Readonly markdown server w/ auth support and live chat, to assist lectures
https://github.com/arnaudjuracek/cahier
Last synced: 13 days ago
JSON representation
Readonly markdown server w/ auth support and live chat, to assist lectures
- Host: GitHub
- URL: https://github.com/arnaudjuracek/cahier
- Owner: arnaudjuracek
- License: mit
- Created: 2021-12-27T15:12:46.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-18T11:10:52.000Z (almost 2 years ago)
- Last Synced: 2024-11-06T23:45:37.333Z (2 months ago)
- Language: JavaScript
- Homepage: https://cahier.arnaudjuracek.fr/
- Size: 1.68 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cahier 
**Readonly markdown server w/ auth support and live chat, to assist lectures**
## Features
- **Directory listing**
- **Markdown** files rendering, with support for:
- Emojis using `:emoji:`
- Marked text using `==mark==`
- Abbreviations
- Quote attribution using `-- Attribution`
- Footnotes
- Code syntax highlighting
- **Front matter** for markdown documents
- `title`
- `description`
- `author`, using the npm format (`Name (website)`)
- `lang`
- `icon`
- `hidden`
- **Live chat** inside a document, using the `[[ discuss ]]` component
- Stored as a `.log` file
- Multiple contexts using `[[ discuss:contextName ]]`
- Readonly using `[[ discuss readonly ]]`
- **Directory access control**, using a `.lock` file inside the directory
- Global password defined as `env` variable
- Local passwords defined inside the `.lock` file (one by line)
## Development
### Installation
```console
$ git clone https://github.com/arnaudjuracek/cahier && cd cahier
$ cp server/.env.example server/.env
$ yarn install
```
### Deployment
Deployment to the AlwaysData environment is done automatically via a [Github action](.github/workflows/deploy-alwaysdata.yml). Simply create a new release by running:
```console
$ yarn version
```
## License
[MIT.](https://tldrlegal.com/license/mit-license)