https://github.com/macdownapp/macdown-site
Source of the official MacDown site to be consumed by Lektor
https://github.com/macdownapp/macdown-site
Last synced: about 1 year ago
JSON representation
Source of the official MacDown site to be consumed by Lektor
- Host: GitHub
- URL: https://github.com/macdownapp/macdown-site
- Owner: MacDownApp
- Created: 2017-01-07T22:35:09.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-15T23:42:06.000Z (over 3 years ago)
- Last Synced: 2025-04-30T03:39:25.994Z (about 1 year ago)
- Language: Python
- Homepage: https://macdown.uranusjr.com
- Size: 1.75 MB
- Stars: 8
- Watchers: 4
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Source files for the official MacDown site
These are [Lektor] source files used to generate . The generated files are hosted on Netlify with the custom domain name.
## Run site locally
1. Install [Lektor].
2. Install Python dependencies: `pip install -r requirements.txt`.
2. Optional: Install [pyobjc-framework-webkit] for faster JavaScript server-side rendering.
3. `invoke build` to build the files. Internet connection is required on the first run.
4. `invoke serve` to launch the dev server.
5. Visit `http://localhost:5000`.
## TODO
Deployment:
* Make sure update-pushing works.
* Add a license file to the repo.
Feature:
* Re-write release script in the main repo to integrate with the JSON publish API.
Markdown renderer:
* `$`-style math.
* Context-aware `$$` math.
* Escape in math syntax.
* Quote syntax.
[Lektor]: https://www.getlektor.com
[pyobjc-framework-webkit]: http://pythonhosted.org/pyobjc-framework-WebKit/