Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unibeautify/website
Webpage for Unibeautifier
https://github.com/unibeautify/website
beautify documentation formatter style-guide unibeautify
Last synced: about 2 months ago
JSON representation
Webpage for Unibeautifier
- Host: GitHub
- URL: https://github.com/unibeautify/website
- Owner: Unibeautify
- License: mit
- Created: 2016-08-28T01:52:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-11-15T19:06:27.000Z (2 months ago)
- Last Synced: 2024-11-15T20:19:17.831Z (2 months ago)
- Topics: beautify, documentation, formatter, style-guide, unibeautify
- Language: TypeScript
- Homepage: https://unibeautify.com/
- Size: 10.1 MB
- Stars: 10
- Watchers: 3
- Forks: 29
- Open Issues: 54
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unibeautify Website
## Supported Beautifiers
See https://github.com/Unibeautify/website/blob/master/scripts/beautifiers.ts for list of supported beautifiers. Beautifiers marked with :warning: require additional manual installation.
| # | Beautifier | Preinstalled | Documentation |
| --- | --- | --- | --- |
| 1 | Black | :warning: | https://unibeautify.com/docs/beautifier-black |
| 2 | Brittany | :warning: | https://unibeautify.com/docs/beautifier-brittany |
| 3 | CSScomb | :white_check_mark: | https://unibeautify.com/docs/beautifier-csscomb |
| 4 | ClangFormat | :warning: | https://unibeautify.com/docs/beautifier-clangformat |
| 5 | ESLint | :white_check_mark: | https://unibeautify.com/docs/beautifier-eslint |
| 6 | Gofmt | :warning: | https://unibeautify.com/docs/beautifier-gofmt |
| 7 | JS-Beautify | :white_check_mark: | https://unibeautify.com/docs/beautifier-js-beautify |
| 8 | PHP-CS-Fixer | :warning: | https://unibeautify.com/docs/beautifier-php-cs-fixer |
| 9 | PHP_CodeSniffer | :warning: | https://unibeautify.com/docs/beautifier-php_codesniffer |
| 10 | Prettier | :white_check_mark: | https://unibeautify.com/docs/beautifier-prettier |
| 11 | Pretty Diff | :white_check_mark: | https://unibeautify.com/docs/beautifier-pretty-diff |
| 12 | TSLint | :white_check_mark: | https://unibeautify.com/docs/beautifier-tslint |
| 13 | YAPF | :warning: | https://unibeautify.com/docs/beautifier-yapf |
| 14 | sqlformat | :warning: | https://unibeautify.com/docs/beautifier-sqlformat |
| 15 | stylelint | :white_check_mark: | https://unibeautify.com/docs/beautifier-stylelint |
## Contributing
Install dependencies:
```
# For scripts
yarn install
# For Docusaurus
cd website
yarn install
```
See the documentation of any supported beautifier above marked with :warning: and install their prerequisites.
Generate the docs for options, languages, and beautifiers:
```
yarn docs
```
We use [Docusaurus](https://docusaurus.io/) to build the website:
```
cd website
yarn start
# navigate to http://localhost:3000
```
## Testing Netlify with Docker
The website is deployed using [Netlify](https://www.netlify.com/).
You can edit the Netlify build command in `scripts/netlify.sh`
and then test by building [Netlify's Docker image](https://github.com/netlify/build-image)
using [Docker Compose](https://github.com/docker/compose):
```
docker-compose build
```