See https://github.com/Unibeautify/website/blob/master/scripts/beautifiers.ts for list of supported beautifiers. Beautifiers marked with
# | Beautifier | Preinstalled | Documentation |
---|---|---|---|
1 | Black | https://unibeautify.com/docs/beautifier-black | |
2 | Brittany | https://unibeautify.com/docs/beautifier-brittany | |
3 | CSScomb | ✅ | https://unibeautify.com/docs/beautifier-csscomb |
4 | ClangFormat | https://unibeautify.com/docs/beautifier-clangformat | |
5 | ESLint | ✅ | https://unibeautify.com/docs/beautifier-eslint |
6 | Gofmt | https://unibeautify.com/docs/beautifier-gofmt | |
7 | JS-Beautify | ✅ | https://unibeautify.com/docs/beautifier-js-beautify |
8 | PHP-CS-Fixer | https://unibeautify.com/docs/beautifier-php-cs-fixer | |
9 | PHP_CodeSniffer | https://unibeautify.com/docs/beautifier-php_codesniffer | |
10 | Prettier | ✅ | https://unibeautify.com/docs/beautifier-prettier |
11 | Pretty Diff | ✅ | https://unibeautify.com/docs/beautifier-pretty-diff |
12 | TSLint | ✅ | https://unibeautify.com/docs/beautifier-tslint |
13 | YAPF | https://unibeautify.com/docs/beautifier-yapf | |
14 | sqlformat | https://unibeautify.com/docs/beautifier-sqlformat | |
15 | stylelint | ✅ | https://unibeautify.com/docs/beautifier-stylelint |
Install dependencies:
# For scripts
yarn install
# For Docusaurus
cd website
yarn install
See the documentation of any supported beautifier above marked with
Generate the docs for options, languages, and beautifiers:
yarn docs
We use Docusaurus to build the website:
cd website
yarn start
# navigate to http://localhost:3000
The website is deployed using Netlify.
You can edit the Netlify build command in scripts/netlify.sh
and then test by building Netlify's Docker image
using Docker Compose:
docker-compose build