monkeytypegame/monkeytype
1
1
Fork 0
mirror of https://github.com/monkeytypegame/monkeytype.git synced 2024-09-20 07:16:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: utilize blockquote color highlights (unrealapex) (#5444)

Browse source 
* docs: add note for unix systems

* docs: use gfm blockquote highlight for note

github flavored markdown supports highlighting of NOTE and WARNING
messages in blockquotes. see
https://github.com/orgs/community/discussions/16925

* docs: fix bold text

Co-authored-by: Warrobot10 <132307750+Warrobot10@users.noreply.github.com>

---------

Co-authored-by: Warrobot10 <132307750+Warrobot10@users.noreply.github.com>
This commit is contained in:
Aaron 2024-05-28 01:32:23 -07:00 committed by GitHub
parent 367569f9b6
commit 272d61cd0a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING_ADVANCED.md
View file

@ -25,7 +25,9 @@ This contribution guide is for cases in which you need to test the functionality
### Git
**IMPORTANT: If you are on Windows, run `git config --global core.autocrlf false` before cloning this repo to prevent CRLF errors.**
> [!WARNING]
> **If you are on Windows, run `git config --global core.autocrlf false` before cloning this repo to prevent CRLF errors.**
Git is optional but we recommend you utilize it. Monkeytype uses the Git source control management (SCM) system for its version control. Assuming you don't have experience typing commands in the command line, we suggest installing [Sourcetree](https://www.sourcetreeapp.com/). You will be able to utilize the power of Git without needing to remember any cryptic commands. Using a Git client such as Sourcetree won't give you access to the full functionality of Git, but provides an easy-to-understand graphical user interface (GUI). Once you have downloaded Sourcetree, run the installer. While installing Sourcetree, keep your eyes peeled for the option to also install Git with Sourcetree. This is the option you will need to look for in order to install Git. **Make sure to click yes in the installer to install Git with Sourcetree.**
@ -145,7 +147,10 @@ npm run dev
These commands will start a local development website on [port 3000](http://localhost:3000) and a local development server on [port 5005](http://localhost:5005). They will automatically rebuild the website/server when you make changes in the `src/` directory. Use <kbd>Ctrl+C</kbd> to stop them.
Note: Rebuilding doesn't happen instantaneously and depends on your machine, so be patient for changes to appear.
> [!NOTE]
> Rebuilding doesn't happen instantaneously and depends on your machine, so be patient for changes to appear.
If you are on a UNIX system and you get a spawn error, run npm with `sudo`.
## Standards and Guidelines

4
SELF_HOSTING.md
View file

@ -196,4 +196,6 @@ Example content from `backend-configuration.json`:
If you have the `curl` and `jq` installed you can also run `curl -wO- http://localhost:5005/configuration | jq ".data" > backend-configuration.json` to update the configuration file.
_Note:_ The configuration is applied on container startup only. You have to restart the container for your changes to become active.
> [!NOTE]
> The configuration is applied on container startup only. You have to restart the container for your changes to become active.