Skip to content

Commit c840070

Browse files
renamed references to branch master into main
1 parent 8a6551f commit c840070

23 files changed

+108
-233
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ body:
8080
validations:
8181
required: true
8282
- type: input
83-
id: vscode_version
83+
id: vscode_version
8484
attributes:
8585
label: Visual Studio Code Version
8686
description: |
@@ -92,6 +92,6 @@ body:
9292
id: additional
9393
attributes:
9494
label: Additional context
95-
description: |
95+
description: |
9696
Add any other context about the problem here.
97-
The Foam log output for VSCode can be found here: https://github.com/foambubble/foam/blob/master/docs/features/foam-logging-in-vscode.md
97+
The Foam log output for VSCode can be found here: https://github.com/foambubble/foam/blob/main/docs/features/foam-logging-in-vscode.md

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ name: CI
33
on:
44
push:
55
branches:
6-
- master
6+
- main
77
pull_request:
88
branches:
9-
- master
9+
- main
1010

1111
jobs:
1212
typos-check:

.github/workflows/update-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Update Docs
33
on:
44
push:
55
branches:
6-
- master
6+
- main
77
paths:
88
- docs/user/**/*
99
- docs/.vscode/**/*

docs/dev/contribution-guide.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
tags: todo, good-first-task
33
---
4+
45
# Contribution Guide
56

67
Foam is open to contributions of any kind, including but not limited to code, documentation, ideas, and feedback.
@@ -44,19 +45,19 @@ You should now be ready to start working!
4445

4546
Foam code and documentation live in the monorepo at [foambubble/foam](https://github.com/foambubble/foam/).
4647

47-
- [/docs](https://github.com/foambubble/foam/tree/master/docs): documentation and [[recipes]].
48+
- [/docs](https://github.com/foambubble/foam/tree/main/docs): documentation and [[recipes]].
4849

4950
Exceptions to the monorepo are:
5051

5152
- The starter template at [foambubble/foam-template](https://github.com/foambubble/)
5253
- All other [[recommended-extensions]] live in their respective GitHub repos
5354

54-
This project uses [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).
55+
This project uses [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).
5556

5657
Originally Foam had:
5758

5859
- [/packages/foam-core](https://github.com/foambubble/foam/tree/ee7a8919761f168d3931079adf21c5ad4d63db59/packages/foam-core) - Powers the core functionality in Foam across all platforms.
59-
- [/packages/foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) - The core VS Code plugin.
60+
- [/packages/foam-vscode](https://github.com/foambubble/foam/tree/main/packages/foam-vscode) - The core VS Code plugin.
6061

6162
To improve DX we have moved the `foam-core` module into `packages/foam-vscode/src/core`, but from a development point of view it's useful to think of the `foam-vscode/src/core` "submodule" as something that might be extracted in the future.
6263

@@ -81,7 +82,7 @@ Tests live alongside the code in `src`.
8182

8283
This guide assumes you read the previous instructions and you're set up to work on Foam.
8384

84-
1. Now we'll use the launch configuration defined at [`.vscode/launch.json`](https://github.com/foambubble/foam/blob/master/.vscode/launch.json) to start a new extension host of VS Code. Open the "Run and Debug" Activity (the icon with the bug on the far left) and select "Run VSCode Extension" in the pop-up menu. Now hit F5 or click the green arrow "play" button to fire up a new copy of VS Code with your extension installed.
85+
1. Now we'll use the launch configuration defined at [`.vscode/launch.json`](https://github.com/foambubble/foam/blob/main/.vscode/launch.json) to start a new extension host of VS Code. Open the "Run and Debug" Activity (the icon with the bug on the far left) and select "Run VSCode Extension" in the pop-up menu. Now hit F5 or click the green arrow "play" button to fire up a new copy of VS Code with your extension installed.
8586

8687
2. In the new extension host of VS Code that launched, open a Foam workspace (e.g. your personal one, or a test-specific one created from [foam-template](https://github.com/foambubble/foam-template)). This is strictly not necessary, but the extension won't auto-run unless it's in a workspace with a `.vscode/foam.json` file.
8788

docs/dev/meeting-notes/foam-core-2020-07-11.md

Lines changed: 0 additions & 128 deletions
This file was deleted.

docs/dev/proposals/link-reference-definition-improvements.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,9 @@ The potential solution:
6666
- For edit-time
6767
- Make edit-time link reference definition generation optional via user settings. They should be on by default, and generating valid markdown links with a relative path to a `.md` file.
6868
- Make format of the link reference definition configurable (whether to include '.md' or not)
69-
- Out of recommended extensions, currently only "markdown links" doesn't support them (?). However even its [code](https://github.com/tchayen/markdown-links/blob/master/src/parsing.ts#L25) seems to include wikilink parser, so it might just be a bug?
69+
- Out of recommended extensions, currently only "markdown links" doesn't support them (?). However even its [code](https://github.com/tchayen/markdown-links/blob/main/src/parsing.ts#L25) seems to include wikilink parser, so it might just be a bug?
7070
- For build-time
71+
7172
- To satisfy mutually incompatible constraints between GitHub UI, VSCode UI, and GitHub Pages, we should add a pre-processing/build step for pushing to GitHub Pages.
7273
- This would be a GitHub action (or a local script, ran via foam-cli) that outputs publish-friendly markdown format for static site generators and other publishing tools
7374
- This build step should be pluggable, so that other transformations could be ran during it
@@ -125,6 +126,7 @@ The potential solution:
125126
- With Foam repo, just use edit-time link reference definitions with '.md' extension - this makes the links work in the GitHub UI
126127
- Have publish target defined for GitHub pages, that doesn't use '.md' extension, but still has the link reference definitions. Generate the output into gh-pages branch (or separate repo) with automation.
127128
- This naturally requires first removing the existing link reference definitions during the build
129+
128130
- Other
129131
- To clean up the search results, remove link reference definition section guards (assuming that these are not defined by the markdown spec). Use unifiedjs parse trees to identify if there's missing (or surplus) definitions (check if they are identified properly by the library), and just add the needed definitions to the bottom of the file (without guards) AND remove them if they are not needed (anywhere from the file).
130132

docs/dev/proposals/roadmap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ If you want to pick up work in this category, you should have a plan on how long
1616

1717
Everything else, categorised into themes. Just because something is on this list doesn't mean it'll get done. If you're interested in working on items in this category, check the [[contribution-guide]] for how to get started.
1818

19-
If a roadmap item is a stub, **consider** opening a [GitHub issue](https://github.com/foambubble/foam/issues) to start a conversation to avoid situations where the implementation does not fit long term vision and roadmap. _Note that this is optional. The only centralised governance in Foam is to decide what ends up in the official [template](https://github.com/foambubble/foam-template), [documentation](https://github.com/foambubble/foam) and [extension](https://github.com/foambubble/foam/tree/master/packages/foam-vscode). You are free to build whatever you want for yourself, and we'd love if you shared it with us, but you are by no means obligated to do so!_
19+
If a roadmap item is a stub, **consider** opening a [GitHub issue](https://github.com/foambubble/foam/issues) to start a conversation to avoid situations where the implementation does not fit long term vision and roadmap. _Note that this is optional. The only centralised governance in Foam is to decide what ends up in the official [template](https://github.com/foambubble/foam-template), [documentation](https://github.com/foambubble/foam) and [extension](https://github.com/foambubble/foam/tree/main/packages/foam-vscode). You are free to build whatever you want for yourself, and we'd love if you shared it with us, but you are by no means obligated to do so!_
2020

2121
**When creating GitHub issues to discuss roadmap items, link them here.**
2222

docs/dev/releasing-foam.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Releasing Foam
22

33
1. Get to the latest code
4-
- `git checkout master && git fetch && git rebase`
4+
- `git checkout main && git fetch && git rebase`
55
2. Sanity checks
66
- `yarn reset`
77
- `yarn test`
8-
3. Update change log
8+
3. Update change log
99
- `./packages/foam-vscode/CHANGELOG.md`
1010
- `git add *`
1111
- `git commit -m"Preparation for next release"`
1212
4. Update version
13-
- `$ yarn version-extension <version>` (where `version` is `patch/minor/major`)
13+
- `$ yarn version-extension <version>` (where `version` is `patch/minor/major`)
1414
5. Package extension
1515
- `$ yarn package-extension`
1616
6. Publish extension

docs/inbox.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Uncategorised thoughts, to be added
1010
- Investigate other similar extensions:
1111
- [Unotes](https://marketplace.visualstudio.com/items?itemName=ryanmcalister.Unotes)
1212
- [vscode-memo](https://github.com/svsool/vscode-memo)
13-
- [gistpad wiki](https://github.com/jevakallio/gistpad/tree/master/src/repos/wiki)
1413
- Open in Foam
1514
- When you want to open a Foam published website in your own VS Code, we could have a "Open in Foam" link that opens the link in VS Code via a url binding (if possible), downloads the github repo locally, and opens it as a Foam workspace.
1615
- Every Foam could have a different theme even in the editor, so you'll see it like they see it

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,17 +60,17 @@ These instructions assume you have a GitHub account, and you have Visual Studio
6060

6161
<a class="github-button" href="https://github.com/foambubble/foam-template/generate" data-icon="octicon-repo-template" data-size="large" aria-label="Use this template foambubble/foam-template on GitHub">Use this template</a>
6262

63-
*If you want to keep your thoughts to yourself, remember to set the repository private, or if you don't want to use GitHub to host your workspace at all, choose [**Download as ZIP**](https://github.com/foambubble/foam-template/archive/master.zip) instead of **Use this template**.*
63+
_If you want to keep your thoughts to yourself, remember to set the repository private, or if you don't want to use GitHub to host your workspace at all, choose [**Download as ZIP**](https://github.com/foambubble/foam-template/archive/main.zip) instead of **Use this template**._
6464

6565
2. [Clone the repository locally](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) and open it in VS Code.
6666

67-
*Open the repository as a folder using the `File > Open...` menu item. In VS Code, "open workspace" refers to [multi-root workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces).*
67+
_Open the repository as a folder using the `File > Open...` menu item. In VS Code, "open workspace" refers to [multi-root workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces)._
6868

6969
3. When prompted to install recommended extensions, click **Install all** (or **Show Recommendations** if you want to review and install them one by one)
7070

7171
After setting up the repository, open `.vscode/settings.json` and edit, add or remove any settings you'd like for your Foam workspace.
7272

73-
* *If using a [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) as noted above, make sure that your **Foam** directory is first in the list. There are some settings that will need to be migrated from `.vscode/settings.json` to your `.code-workspace` file.*
73+
- _If using a [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) as noted above, make sure that your **Foam** directory is first in the list. There are some settings that will need to be migrated from `.vscode/settings.json` to your `.code-workspace` file._
7474

7575
To learn more about how to use **Foam**, read the [[recipes]].
7676

0 commit comments

Comments
 (0)