Skip to content

Commit dade3dd

Browse files
committed
chore: add prettier ignore blocks to docs
1 parent f18a86d commit dade3dd

File tree

8 files changed

+17
-2
lines changed

8 files changed

+17
-2
lines changed

docs/CONTRIBUTING.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- prettier-ignore-start -->
12
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
23
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
34
# Contributing
@@ -24,6 +25,7 @@
2425
- [Currently Known Issues](#currently-known-issues)
2526

2627
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
28+
<!-- prettier-ignore-end -->
2729

2830
- [Detailed CI and build process docs](../ci)
2931

docs/FAQ.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- prettier-ignore-start -->
12
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
23
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
34
# FAQ
@@ -33,6 +34,7 @@
3334
- [How do I change the port?](#how-do-i-change-the-port)
3435

3536
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
37+
<!-- prettier-ignore-end -->
3638

3739
## Questions?
3840

docs/MAINTAINING.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- prettier-ignore-start -->
12
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
23
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
34
# Maintaining
@@ -24,6 +25,7 @@
2425
- [Troubleshooting](#troubleshooting)
2526

2627
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
28+
<!-- prettier-ignore-end -->
2729

2830
This document is meant to serve current and future maintainers of code-server,
2931
as well as share our workflow for maintaining the project.

docs/guide.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- prettier-ignore-start -->
12
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
23
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
34
# Setup Guide
@@ -22,6 +23,7 @@
2223
- [Option 2: ngrok tunnel](#option-2-ngrok-tunnel)
2324

2425
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
26+
<!-- prettier-ignore-end -->
2527

2628
This article will walk you through exposing code-server securely once you've
2729
completed the [installation process](install.md).
@@ -89,11 +91,10 @@ we recommend using another method, such as [Let's Encrypt](#let-encrypt) instead
8991
using [mutagen](https://mutagen.io/documentation/introduction/installation)
9092
to do so. Once you've installed mutagen, you can port forward as follows:
9193

92-
```console
94+
```shell
9395
# This is the same as the above SSH command, but it runs in the background
9496
# continuously. Be sure to add `mutagen daemon start` to your ~/.bashrc to
9597
# start the mutagen daemon when you open a shell.
96-
9798
mutagen forward create --name=code-server tcp:127.0.0.1:8080 < instance-ip > :tcp:127.0.0.1:8080
9899
```
99100

docs/install.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- prettier-ignore-start -->
12
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
23
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
34
# Install
@@ -24,6 +25,7 @@
2425
- [Debian, Ubuntu](#debian-ubuntu-1)
2526

2627
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
28+
<!-- prettier-ignore-end -->
2729

2830
This document demonstrates how to install `code-server` on various distros and
2931
operating systems.

docs/ipad.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- prettier-ignore-start -->
12
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
23
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
34
# iPad
@@ -13,6 +14,7 @@
1314
- [Sharing a self-signed certificate with an iPad](#sharing-a-self-signed-certificate-with-an-ipad)
1415

1516
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
17+
<!-- prettier-ignore-end -->
1618

1719
Once you've installed code-server, you can access it from an iPad.
1820

docs/npm.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- prettier-ignore-start -->
12
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
23
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
34
# npm Install Requirements
@@ -15,6 +16,7 @@
1516
- [Debugging install issues with npm](#debugging-install-issues-with-npm)
1617

1718
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
19+
<!-- prettier-ignore-end -->
1820

1921
If you're installing code-server via `npm`, you'll need to install additional
2022
dependencies required to build the native modules used by VS Code. This article

docs/termux.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- prettier-ignore-start -->
12
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
23
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
34
# Termux
@@ -14,6 +15,7 @@
1415
- [Working with PRoot](#working-with-proot)
1516

1617
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
18+
<!-- prettier-ignore-end -->
1719

1820
## Install
1921

0 commit comments

Comments
 (0)