https://github.com/deepflowinc-oss/cmark-combinators
A Haskell utility library to generate well-formed CommonMark, thin wrapper around cmark package
https://github.com/deepflowinc-oss/cmark-combinators
cmark commonmark haskell markdown oss text
Last synced: 7 months ago
JSON representation
A Haskell utility library to generate well-formed CommonMark, thin wrapper around cmark package
- Host: GitHub
- URL: https://github.com/deepflowinc-oss/cmark-combinators
- Owner: deepflowinc-oss
- License: other
- Created: 2024-02-29T01:28:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-20T11:07:10.000Z (over 1 year ago)
- Last Synced: 2024-12-20T12:38:28.521Z (over 1 year ago)
- Topics: cmark, commonmark, haskell, markdown, oss, text
- Language: Haskell
- Homepage:
- Size: 96.7 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# cmark-combinators - Simple utility around CMark for Haskell
This package provides a utility to generate well-formed CommonMark, wrapping around [`cmark`](https://hackage.haskell.org/package/cmark) package.
## Contribution
Please feel free to open an issue, but also please search for existing issues to check if there already is a similar one.
See [CONTRIBUTING.md][CONTRIBUTING] for more details.
[CONTRIBUTING]: ./CONTRIBUTING.md
## Matrix Build
To add/remove a specific ghc version to/from the tested versions, you can just add/remove cabal's freeze file as `ci/configs/ghc-X.X.X.project` and add the following to the header:
```cabal
import: ../../cabal.project
-- FIXME: Use Appropriate timestamp for index-state
index-state: hackage.haskell.org 2024-02-05T22:44:18Z
```
Note that the actual value of `index-state` should be sufficiently new.
Except this, no modification to Action worklow file is needed in general.
The following is the example command to add the `ghc-9.8.1` with the most recent Stackage Nightly:
```bash
curl --location https://www.stackage.org/nightly/cabal.config > ./ci/configs/ghc-9.8.1.project
cat <>./ci/configs/ghc-9.8.1.project
import: ../../cabal.project
-- FIXME: Use an appropriate timestamp for index-state
index-state: hackage.haskell.org 2024-02-05T22:44:18Z
EOF
```
Note that we might have to edit `with-compiler` stanza of the downloaded freeze file when you want to test GHC version different from Stackage's default version.
If you want to test some breeding-edge version of GHC but to allow failure, name freeze file as `ghc-X.X.X-head.project`.
```bash
curl --location https://www.stackage.org/nightly/cabal.config > ./ci/configs/ghc-9.10.1-head.project
```
## Copyright
2024 (c) DeepFlow, Inc.