-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
29f92fb
commit 5a4a0a5
Showing
88 changed files
with
3,690 additions
and
400 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| title: Manually create a new site | ||
| description: Lets manually create a new website with markata. | ||
|
|
||
| --- | ||
|
|
||
| Markata has some templates that let you get up and running quickly, but you | ||
| _can_ make a site with only markdown if you wanted. | ||
|
|
||
| ### Installation | ||
|
|
||
| `markata` is hosted on pypi and can be installed using pip. | ||
|
|
||
| ```bash | ||
| python -m pip install markata | ||
|
|
||
| # or if pipx is your thing | ||
|
|
||
| pipx install markata | ||
| ``` | ||
|
|
||
| ### Create Some Content | ||
|
|
||
| Make some `.md` files in your current working directory. By default, `markata` | ||
| will recursively look in all subdirectories for markdown files `**/*.md`. | ||
|
|
||
| ```bash | ||
| mkdir pages | ||
| echo '# My First Post' > first-post.md | ||
| echo '# Hello World' > hello-world.md | ||
| ``` | ||
|
|
||
| > This example shows how you can build a site from only a single markdown | ||
| > file. | ||
| ### Build your site | ||
|
|
||
| Install markata into your virtual environment and run `markata build`. It will | ||
| create your site in `./markout`, leave its cache in `./.markata.cache`, and | ||
| copy all assets from `./static` into `./markout` by default. | ||
|
|
||
| ```bash | ||
| python -m pip install markata | ||
| markata build | ||
|
|
||
| # or if pipx is your thing | ||
| pipx run markata build | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
|
|
||
| record-tapes: | ||
| #!/usr/bin/env bash | ||
| set -euxo pipefail | ||
| # Export the function to be used by parallel | ||
| convert_tape() { | ||
| tape_file="$1" | ||
| base_name=$(basename "$tape_file" .tape) | ||
| vhs "tapes/$base_name.tape" -o "static/$base_name.gif" | ||
| } | ||
| export -f convert_tape | ||
| # Find all .tape files and run the convert_tape function in parallel | ||
| find tapes -name '*.tape' | parallel convert_tape | ||
|
|
||
|
|
||
| cov: | ||
| #!/usr/bin/env bash | ||
| set -euxo pipefail | ||
| pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=markata --cov=tests tests | ||
|
|
||
| no-cov: | ||
| #!/usr/bin/env bash | ||
| set -euxo pipefail | ||
| pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=markata --cov=tests tests --no-cov | ||
| lint: | ||
| #!/usr/bin/env bash | ||
| set -euxo pipefail | ||
| ruff check markata | ||
| format: | ||
| #!/usr/bin/env bash | ||
| set -euxo pipefail | ||
| ruff format . | ||
| build-docs: | ||
| #!/usr/bin/env bash | ||
| set -euxo pipefail | ||
| markata build | ||
| serve: | ||
| #!/usr/bin/env bash | ||
| set -euxo pipefail | ||
| python -m http.server --bind 0.0.0.0 8000 --directory markout | ||
| ruff-fix: | ||
| #!/usr/bin/env bash | ||
| set -euxo pipefail | ||
| ruff check markata --fix | ||
| lint-format: lint format | ||
|
|
||
| lint-test: lint format cov | ||
|
|
||
|
|
||
|
|
Oops, something went wrong.