https://github.com/audreyfeldroy/deckthehalls
A merry FastHTML nbdev project that uses Pygments for Christmas joy
https://github.com/audreyfeldroy/deckthehalls
Last synced: 3 months ago
JSON representation
A merry FastHTML nbdev project that uses Pygments for Christmas joy
- Host: GitHub
- URL: https://github.com/audreyfeldroy/deckthehalls
- Owner: audreyfeldroy
- License: apache-2.0
- Created: 2024-12-25T13:27:48.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-12-25T15:20:07.000Z (5 months ago)
- Last Synced: 2024-12-25T15:22:17.657Z (5 months ago)
- Language: Jupyter Notebook
- Homepage: https://audreyfeldroy.github.io/deckthehalls
- Size: 358 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# deckthehalls
This file will become your README and also the index of your
documentation.
## Developer Guide
If you are new to using `nbdev` here are some useful pointers to get you
started.
### Install deckthehalls in Development mode
``` sh
# make sure deckthehalls package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to deckthehalls
$ nbdev_prepare
```
## Usage
### Installation
Install latest from the GitHub
[repository](https://github.com/audreyfeldroy/deckthehalls):
``` sh
$ pip install git+https://github.com/audreyfeldroy/deckthehalls.git
```
or from [conda](https://anaconda.org/audreyfeldroy/deckthehalls)
``` sh
$ conda install -c audreyfeldroy deckthehalls
```
or from [pypi](https://pypi.org/project/deckthehalls/)
``` sh
$ pip install deckthehalls
```
### Documentation
Documentation can be found hosted on this GitHub
[repository](https://github.com/audreyfeldroy/deckthehalls)’s
[pages](https://audreyfeldroy.github.io/deckthehalls/). Additionally you
can find package manager specific guidelines on
[conda](https://anaconda.org/audreyfeldroy/deckthehalls) and
[pypi](https://pypi.org/project/deckthehalls/) respectively.
## How to use
Fill me in please! Don’t forget code examples:
``` python
1+1
```
2