Skip to content

Commit dbd6a63

Browse files
Open sections by default in the README
1 parent 4627b92 commit dbd6a63

File tree

1 file changed

+25
-62
lines changed

1 file changed

+25
-62
lines changed

README.md

Lines changed: 25 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -4,45 +4,18 @@ GistPad is a Visual Studio Code extension that allows you to edit GitHub [Gists]
44

55
<img src="https://user-images.githubusercontent.com/116461/69910156-96274b80-13fe-11ea-9be4-d801f4e9c377.gif" width="750px" />
66

7-
## Table of Contents
8-
9-
- **[Getting Started](#getting-started)**
10-
- **[Gist Management](#gist-management)**
11-
- [Sorting and grouping](#sorting-and-grouping)
12-
- [Files and Directories](#files-and-directories)
13-
- [Archiving Gists](#archiving-gists)
14-
- [Commenting](#gist-commenting)
15-
- [Pasting Images](#pasting-images)
16-
- [Following Users](#following-users)
17-
- [Exporting to Repositories](#exporting-to-repositories)
18-
- [Daily Notes](#daily-notes)
19-
- [Showcase](#showcase)
20-
- **[Repository Management](#repositories)**
21-
- [Branches](#branches)
22-
- [Wikis](#wikis)
23-
- **[CodeSwing](#codeswing)**
24-
- **[Copilot chat](#copilot-chat)**
25-
- **[Contributed Commands](#contributed-commands-file-explorer)**
26-
- **[Configuration Settings](#configuration-settings)**
27-
28-
<details>
29-
<summary>Getting Started</summary>
30-
31-
## Getting Started
7+
## 🏃 Getting Started
328

339
1. Install this extension from the marketplace, then run `Developer: Reload Window`.
3410

3511
1. Open the `GistPad` tab _(look for the notebook icon in the activity bar)_. From there, you can open a gist or GitHub repo by ID/URL, or sign in with a GitHub account in order to manage your [gists](#gist-management) and [repositories](#repositories). To sign-in, simply click the `Sign In` button and follow the provided flow in order to authenticate with your GitHub account.
3612

3713
From here, you can create and edit [gists](#gist-management), [repositories](#repositories), [wikis](#wikis) and [runnable code samples](#codeswing). And in addition to doing this from the `Gists` tree view, you can also do it from [Copilot chat](#copilot-chat) (thanks to a [built-in MCP server](https://npmjs.com/gistpad-mcp)). Have fun, and let us know how we can make your knowledge-management experience even more awesome! 🙌
38-
<br>
3914

40-
[Back to Table of Contents](#table-of-contents)
41-
</details>
42-
<details>
43-
<summary>Gist Management</summary>
15+
---
4416

45-
## Gist Management
17+
<details open>
18+
<summary><h2>Gist Management</h2></summary>
4619

4720
In order to create a new gist, simply open the `Gists` tree in the `GistPad` tab, and click the `+` icon in the toolbar. Specify the description and files to seed it with (including support for [directories](#files-and-directories)!). Additionally, you can create gists from local files or snippets by right-clicking them in the `Explorer` tree, or by right-clicking an editor window/tab and selecting `Copy File to Gist`, `Add Selection to Gist`, or `Paste Gist File Contents` ([details](#contributed-commands-editor)).
4821

@@ -145,12 +118,10 @@ To see what can be done with gists and [code swings](#codeswing), and to keep up
145118
<img width="250px" src="https://user-images.githubusercontent.com/116461/74891549-2c9f4500-533c-11ea-9bbb-c5907d41a589.png" />
146119
<br>
147120

148-
[Back to Table of Contents](#table-of-contents)
149121
</details>
150-
<details>
151-
<summary>Repository Management</summary>
152-
153-
## Repositories
122+
123+
<details open>
124+
<summary><h2>Repository Management</h2></summary>
154125

155126
GistPad also allows you to create and edit GitHub repos without needing to clone anything locally. To get started, run the `GistPad: Open Repository` command, and specify/select the name of the repo you'd like to start managing. If you want to create a new repo, then select the `Create new repo` or `Create new private repo` options, then specify the name of the repo.
156127

@@ -230,44 +201,37 @@ Furthermore, when you open a page that contains backlinks, the set of backlinks
230201
#### Embedding Files
231202

232203
In addition to adding links to pages, it's sometimes valuable to embed the contents of another page directly into a note, so that you can easily read them together. To do this, you can use the `![[link]]` syntax, where you'll recieve auto-completion support just like regular links. When you use an embed link, the target page's contents will be displayed within the note whenever you view it's markdown preview.
233-
<br>
234204

235-
[Back to Table of Contents](#table-of-contents)
236205
</details>
237-
<details>
238-
<summary>CodeSwing</summary>
239-
240-
## CodeSwing
206+
207+
<details open>
208+
<summary><h2>CodeSwing</h2></summary>
241209

242210
If you're building web applications, and want to create a quick playground environment in order to experiment with HTML, CSS or JavaScript (or [Sass/SCSS, Less, Pug and TypeScript](#additional-language-support)), you can install the [CodeSwing extension](https://aka.ms/codeswing), in order to have a CodePen-like web experience, integrated into VS Code. GistPad provides an integration with CodeSwing, and so once it's installed, you can right-click the `Your Gists` node in the `GistPad` tree and select `New CodeSwing` or `New Secret CodeSwing`. This will create a new gist, seeded with the selected template fields, and then provide you with a live preview Webview, so that you can iterate on the code and visually see how it behaves.
243211

244212
When you create a new swing, you'll be asked to select a template, which is simply a way to get started quickly, using the libraries and languages you intend to use (e.g. React.js, Vue.js). Since the swing is backed by a Gist, your changes are saved and shareable with your friends. Additionally, as you find other swings that you'd like to use, simply fork them and create your own swings. That way, you can use Gists as "templates" for swing environments, and collaborate on them with others just like you would any other gist. When you're done with a swing, simply close the preview window and all other documents will be automatically closed. If you no longer need the swing, then delete it just like any other gist 👍
245-
<br>
246213

247-
[Back to Table of Contents](#table-of-contents)
248214
</details>
249-
<details>
250-
<summary>Copilot chat</summary>
251-
252-
## Copilot chat
215+
216+
<details open>
217+
<summary><h2>Copilot chat</h2></summary>
253218

254219
In addition to managing gists via the `Gists` tree view, you can also use Copilot chat (in `Agent` mode) to discuss and edit your gists/daily notes via natural language. For example, if you opened up Copilot chat and asked `What is the summary of my <X> gist?`, then Copilot would look up your list of gists, find the one about `<X>`, and then generate a summary for you. Or if you asked `Create a new gist that talks about the JavaScript programming language?`, then Copilot would generate a description + file contents based on the requested topic and then create a new gist for you.
255220

256221
This experience works because the GistPad extension ships with the [GistPad MCP server](https://npmjs.com/gistpad-mcp) out of the box. Beyond simplifying setup, this approach is also more secure, since it creates and manages a GitHub token on your behald, with the minimal scopes. For more details about what you can do with GistPad + Copilot, refer to the `GistPad > MCP` settings and/or check out the docs for the GistPad MCP server (including it's list of tools, resources, and prompts support).
257-
<br>
258222

259-
[Back to Table of Contents](#table-of-contents)
260223
</details>
261-
<details>
262-
<summary>Contributed Commands</summary>
224+
225+
<details open>
226+
<summary><h2>Contributed Commands</h2></summary>
263227

264-
## Contributed Commands (File Explorer)
228+
### Contributed Commands (File Explorer)
265229

266230
In addition to the `Gists` view, GistPad also contributes an `Copy File to Gist` command to the context menu of the `Explorer` file tree, which allows you to easily add local files to a new or existing Gist.
267231

268232
<img width="260px" src="https://user-images.githubusercontent.com/116461/69831695-58001100-11df-11ea-997e-fc8020556348.png" />
269233

270-
## Contributed Commands (Editor)
234+
### Contributed Commands (Editor)
271235

272236
In addition to the `Explorer` file tree commands, GistPad also contributes the following commands to the editor's context menu:
273237

@@ -281,7 +245,7 @@ In addition to the `Explorer` file tree commands, GistPad also contributes the f
281245

282246
The `Copy File to Gist` command is also available on the editor tab's context menu.
283247

284-
## Contributed Commands (Editor Title Bar)
248+
### Contributed Commands (Editor Title Bar)
285249

286250
In addition to the commands added to the editor context menu, GistPad also contributes the following commands to the editor's title bar menu (click the `...` in the upper right section of an editor window):
287251

@@ -292,7 +256,7 @@ Additionally, if you disable the `Gistpad: Sync on Save` setting, then the follo
292256

293257
- `Sync Gist` - Sync the file's pending changes back to GitHub.
294258

295-
## Contributed Commands (Command Palette)
259+
### Contributed Commands (Command Palette)
296260

297261
In addition to the `Gists` view, this extension also provides the following commands:
298262

@@ -323,14 +287,11 @@ In addition to the `Gists` view, this extension also provides the following comm
323287
- `GistPad: Starred Gists` - Lists your starred Gists, and then opens the files for the selected one.
324288

325289
- `GistPad: Paste Gist File` - Allows you to paste the contents of a gist file into the active editor.
326-
<br>
327290

328-
[Back to Table of Contents](#table-of-contents)
329291
</details>
330-
<details>
331-
<summary>Configuration Settings</summary>
332-
333-
## Configuration Settings
292+
293+
<details open>
294+
<summary><h2>Configuration Settings</h2></summary>
334295

335296
- `GistPad > Comments: Show Thread` - Specifies when to show the comment thread UI whenever you open a gist file. Can be set to one of the following values:
336297

@@ -393,3 +354,5 @@ In addition to the `Gists` view, this extension also provides the following comm
393354
- `Gistpad > Wikis > Daily: Title Format` - Specifies the date format (using Moment.js syntax) that is used to for the title of daily pages. Defaults to `LL`.
394355

395356
- `Gistpad > Wikis > Daily: Filename Format` - Specifies the date format (using Moment.js syntax) that is used to for the filename of daily pages. Defaults to `YYYY-MM-DD`.
357+
358+
</details>

0 commit comments

Comments
 (0)