Unibeautify Website

Supported Beautifiers

See https://github.com/Unibeautify/website/blob/master/scripts/beautifiers.ts for list of supported beautifiers. Beautifiers marked with ⚠️ require additional manual installation.

#	Beautifier	Preinstalled	Documentation
1	Black	⚠️	https://unibeautify.com/docs/beautifier-black.html
2	CSScomb	✅	https://unibeautify.com/docs/beautifier-csscomb.html
3	ClangFormat	⚠️	https://unibeautify.com/docs/beautifier-clangformat.html
4	ESLint	✅	https://unibeautify.com/docs/beautifier-eslint.html
5	Gofmt	⚠️	https://unibeautify.com/docs/beautifier-gofmt.html
6	JS-Beautify	✅	https://unibeautify.com/docs/beautifier-js-beautify.html
7	PHP-CS-Fixer	⚠️	https://unibeautify.com/docs/beautifier-php-cs-fixer.html
8	PHP_CodeSniffer	⚠️	https://unibeautify.com/docs/beautifier-php_codesniffer.html
9	Prettier	✅	https://unibeautify.com/docs/beautifier-prettier.html
10	Pretty Diff	✅	https://unibeautify.com/docs/beautifier-pretty-diff.html
11	TSLint	✅	https://unibeautify.com/docs/beautifier-tslint.html
12	YAPF	⚠️	https://unibeautify.com/docs/beautifier-yapf.html
13	sqlformat	⚠️	https://unibeautify.com/docs/beautifier-sqlformat.html

Install dependencies:

# For scripts
yarn install

# For Docusaurus
cd website
yarn install

See the documentation of any supported beautifier above marked with ⚠️ and install their prerequisites.

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: