https://github.com/mondeja/project-config-styles
My own styles for https://github.com/mondeja/project-config
https://github.com/mondeja/project-config-styles
Last synced: about 2 months ago
JSON representation
My own styles for https://github.com/mondeja/project-config
- Host: GitHub
- URL: https://github.com/mondeja/project-config-styles
- Owner: mondeja
- License: bsd-3-clause
- Created: 2022-06-12T13:35:08.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-02-05T17:17:31.000Z (8 months ago)
- Last Synced: 2025-04-15T15:12:21.989Z (6 months ago)
- Language: Shell
- Homepage: https://mondeja.github.io/project-config/
- Size: 179 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# My own [project-config] styles
## Base styles (`base/`)
- `project-config.json5`: Configuration for [project-config] using a
`pyproject.toml` file and [pre-commit] to run it.
### Pre-commit hooks (`base/pre-commit/`)
- `md2po2md.json5`: [md2po2md] configuration for [pre-commit]
to convert Markdown to PO and back.
- `prettier.json5`: minimal [prettier] configuration for [pre-commit] to
format files. You can add more files to check adding the styles
`base/pre-commit/pretter/{format}.json5`, see the current
[supported files][pre-commit-prettier-formats] or
[contribute with your own][pull-requests-link].
## Python (`python/`)
- `base.json5`: Base styles for Python. Include it at start. Use [hatch]
for building, versioning, environments and publishing. Use [pre-commit]
for linting and formatting.
- `sphinx.json5`: Documentation using Sphinx.
- `readthedocs.json5`: Documentation using ReadTheDocs theme for Sphinx.
- `mdpo.json5`: Documentation with Markdown files, translations using
[mdpo] with [pre-commit].
- `mypy.json5`: Type checking using [mypy] with [pre-commit].
[project-config]: https://github.com/mondeja/project-config
[mdpo]: https://mondeja.github.io/mdpo/
[mypy]: https://mypy.readthedocs.io/en/latest/
[pre-commit]: https://pre-commit.com
[md2po2md]: https://mondeja.github.io/mdpo/latest/pre-commit-hooks.html#md2po2md
[prettier]: https://prettier.io
[hatch]: https://hatch.pypa.io/
[pull-requests-link]: https://github.com/mondeja/project-config-styles/pulls
[pre-commit-prettier-formats]: https://github.com/mondeja/project-config-styles/tree/master/base/pre-commit/prettier