Compare commits

...

11 Commits

Author SHA1 Message Date
Jani Eväkallio
9a3e2a0b10 Random associations 2020-07-12 19:25:05 +01:00
Jani Eväkallio
75431c89ba Add missing all-contributors 2020-07-12 16:54:33 +01:00
Ayush Baweja
9e064be3f0 Add custom CSS recipe for Markdown preview (#101)
Co-authored-by: Jani Eväkallio <jani.evakallio@gmail.com>
2020-07-12 16:49:03 +01:00
Ankit Tiwari
2b3f351330 Add VS Code Marketplace shield badges (#99) 2020-07-12 16:36:10 +01:00
Ankit Tiwari
1c01c266d9 Remove references to foam-workspace-manager (#100) 2020-07-12 16:35:11 +01:00
Jani Eväkallio
2501638a55 v0.2.0 2020-07-12 15:16:58 +01:00
Jani Eväkallio
20ae1f2ad9 Prepare for 0.2.0 release 2020-07-12 15:16:28 +01:00
Jani Eväkallio
a94110898b Add lerna 2020-07-12 14:50:43 +01:00
Riccardo
3191d7ddf3 Merge pull request #83 from foambubble/spike-core-graph
Factored out graph operations and moved some code into core
2020-07-12 13:12:31 +02:00
Ankit Tiwari
086884ff5c Fix all contributors badge (#97) 2020-07-12 09:18:07 +01:00
Saurav Khdoolia
05cbdc1c04 Update Contributor Image Link 🧐 in Readme (#96) 2020-07-12 08:21:02 +01:00
18 changed files with 3034 additions and 78 deletions

View File

@@ -158,6 +158,34 @@
"contributions": [
"doc"
]
},
{
"login": "sauravkhdoolia",
"name": "Saurav Khdoolia",
"avatar_url": "https://avatars1.githubusercontent.com/u/34188267?v=4",
"profile": "https://github.com/sauravkhdoolia",
"contributions": [
"doc"
]
},
{
"login": "anku255",
"name": "Ankit Tiwari",
"avatar_url": "https://avatars1.githubusercontent.com/u/22813027?v=4",
"profile": "https://anku.netlify.com/",
"contributions": [
"doc",
"test"
]
},
{
"login": "ayushbaweja",
"name": "Ayush Baweja",
"avatar_url": "https://avatars1.githubusercontent.com/u/44344063?v=4",
"profile": "https://github.com/ayushbaweja",
"contributions": [
"doc"
]
}
],
"contributorsPerLine": 7

1
.gitignore vendored
View File

@@ -1,6 +1,7 @@
node_modules
.DS_Store
.vscode-test/
*.tsbuildinfo
*.vsix
*.log
dist

View File

@@ -12,6 +12,7 @@
- What use cases are we working towards?
-[[todo]] User round table
[//begin]: # "Autogenerated link references for markdown compatibility"
[todo]: todo "Todo"
[//end]: # "Autogenerated link references"

View File

@@ -12,7 +12,7 @@ Foam is open to contributions of any kind, including but not limited to code, do
- Foam code and documentation live in the monorepo at [foambubble/foam](https://github.com/foambubble/foam/)
- [/docs](https://github.com/foambubble/foam/docs): documentation and [[recipes]]
- [/packages/foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode): the core VSCode plugin
- [/packages/foam-workspace-manager](https://github.com/foambubble/foam/tree/master/packages/foam-workspace-manager): Foam workspace automations
- [/packages/foam-core](https://github.com/foambubble/foam/tree/master/packages/foam-core): powers the core functionality in Foam across all platforms
- Exceptions to the monorepo are:
- The starter template at [foambubble/foam-template](https://github.com/foambubble/)
- All other [[recommended-extensions]] live in their respective GitHub repos.
@@ -29,9 +29,9 @@ If you're interested in contributing to the VS Code extension (aka `foam-vscode`
`yarn install`
3. This project uses [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).`foam-vscode` relies on `foam-workspace-manager`. This means we need to compile it before we do any extension development. From the root, run the command:
3. This project uses [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).`foam-vscode` relies on `foam-core`. This means we need to compile it before we do any extension development. From the root, run the command:
`yarn workspace foam-workspace-manager build`
`yarn workspace foam-core build`
4. 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. From the root, or the `foam-vscode` workspace, press f5.
5. 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). This is strictly not necessary, but the extension won't auto-run unless it's in a workspace with a `.vscode/foam.json` file.

View File

@@ -0,0 +1,15 @@
# Custom Markdown Preview Styles
Visual Studio Code allows you to use your own CSS in the Markdown preview tab.
## Instructions
Custom CSS for the Markdown preview can be implemented by using the `"markdown.styles": []` setting in `settings.json`. The stylesheets can either be https URLs or relative paths to local files in the current workspace.
For example, to load a stylesheet called `Style.css`, we can update `settings.json` with the following line:
```
{
"markdown.styles": ["Style.css"]
}
```

View File

@@ -1,12 +1,16 @@
# Inbox
Uncategorised thoughts
Uncategorised thoughts, to be added
- Release notes
- Automatic updates
- Markdown Preview
- It's possible to customise the markdown preview styling. **Maybe make it use local foam workspace styles for live preview of the site??**
- See: https://marketplace.visualstudio.com/items?itemName=bierner.markdown-preview-github-styles
- Use VS Code [CodeTour](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.codetour) for onboarding
- Investigate other similar extensions:
- [Unotes](https://marketplace.visualstudio.com/items?itemName=ryanmcalister.Unotes)
- [vscode-memo](https://github.com/svsool/vscode-memo)
- Foam as a (VS Code) language
- Syntax highlighting
- Autocompletion

View File

@@ -126,6 +126,9 @@ If that sounds like something you're interested in, I'd love to have you along o
<tr>
<td align="center"><a href="https://styfle.dev/"><img src="https://avatars1.githubusercontent.com/u/229881?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Steven</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=styfle" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/Georift"><img src="https://avatars2.githubusercontent.com/u/859430?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Tim</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Georift" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/sauravkhdoolia"><img src="https://avatars1.githubusercontent.com/u/34188267?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Saurav Khdoolia</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=sauravkhdoolia" title="Documentation">📖</a></td>
<td align="center"><a href="https://anku.netlify.com/"><img src="https://avatars1.githubusercontent.com/u/22813027?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Ankit Tiwari</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=anku255" title="Documentation">📖</a> <a href="https://github.com/foambubble/foam/commits?author=anku255" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/ayushbaweja"><img src="https://avatars1.githubusercontent.com/u/44344063?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Ayush Baweja</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=ayushbaweja" title="Documentation">📖</a></td>
</tr>
</table>

View File

@@ -37,6 +37,7 @@ Guides, tips and strategies for getting the most out of your Foam workspace!
- Use shortcuts for [[creating-new-notes]]
- Draw [[diagrams-in-markdown]]
- Prettify your links, [[automatically-expand-urls-to-well-titled-links]]
- Style your environment with [[custom-markdown-preview-styles]]
- [Markdown All-in-One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) features [[todo]] [[good-first-task]]
- Manage checklists
- Automatic Table of Contents
@@ -93,8 +94,9 @@ _See [[contribution-guide]] and [[how-to-write-recipes]]._
[wiki-links]: wiki-links "Wiki Links"
[creating-new-notes]: creating-new-notes "Creating New Notes"
[diagrams-in-markdown]: diagrams-in-markdown "Diagrams in Markdown"
[good-first-task]: good-first-task "Good First Task"
[automatically-expand-urls-to-well-titled-links]: automatically-expand-urls-to-well-titled-links "Automatically Expand URLs to Well-Titled Links"
[custom-markdown-preview-styles]: custom-markdown-preview-styles "Custom Markdown Preview Styles"
[good-first-task]: good-first-task "Good First Task"
[git-integration]: git-integration "Git integration"
[github-pages]: github-pages "Github Pages"
[customising-styles]: customising-styles "Customising Styles"

8
lerna.json Normal file
View File

@@ -0,0 +1,8 @@
{
"packages": [
"packages/*"
],
"npmClient": "yarn",
"useWorkspaces": true,
"version": "0.2.0"
}

View File

@@ -1,6 +1,6 @@
{
"name": "foam",
"version": "0.0.1",
"version": "0.2.0",
"description": "Foam",
"repository": "git@github.com:foambubble/foam.git",
"author": "Jani Eväkallio <jani.evakallio@gmail.com>",
@@ -13,7 +13,8 @@
"watch": "yarn workspace foam-vscode watch"
},
"devDependencies": {
"all-contributors-cli": "^6.16.1"
"all-contributors-cli": "^6.16.1",
"lerna": "^3.22.1"
},
"engines": {
"node": ">=10"

View File

@@ -19,7 +19,7 @@ $ npm install -g foam-cli
$ foam COMMAND
running command...
$ foam (-v|--version|version)
foam-cli/0.1.0 darwin-x64 node-v12.18.0
foam-cli/0.2.0 darwin-x64 node-v12.18.0
$ foam --help [COMMAND]
USAGE
$ foam COMMAND
@@ -49,7 +49,7 @@ EXAMPLE
hello world from ./src/hello.ts!
```
_See code: [src/commands/hello.ts](https://github.com/foambubble/foam/blob/v0.1.0/src/commands/hello.ts)_
_See code: [src/commands/hello.ts](https://github.com/foambubble/foam/blob/v0.2.0/src/commands/hello.ts)_
## `foam help [COMMAND]`

View File

@@ -1,7 +1,7 @@
{
"name": "foam-cli",
"description": "Foam CLI",
"version": "0.1.0",
"version": "0.2.0",
"author": "Jani Eväkallio @jevakallio",
"bin": {
"foam": "./bin/run"
@@ -20,13 +20,13 @@
"eslint": "^5.13",
"eslint-config-oclif": "^3.1",
"eslint-config-oclif-typescript": "^0.1",
"foam-core": "^0.2.0",
"globby": "^10",
"ts-node": "^8",
"typescript": "^3.3",
"foam-core": "^0.1.1"
"typescript": "^3.3"
},
"peerDependencies": {
"foam-core": "^0.1.1"
"foam-core": "^0.2.0"
},
"engines": {
"node": ">=8.0.0"

View File

@@ -2,7 +2,7 @@
"name": "foam-core",
"author": "Jani Eväkallio",
"repository": "https://github.com/foambubble/foam",
"version": "0.1.1",
"version": "0.2.0",
"license": "MIT",
"files": [
"dist"

View File

@@ -4,6 +4,22 @@ All notable changes to the "foam-vscode" extension will be documented in this fi
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
## [0.2.0] - 2020-07-12
Improvements:
- Order link references alphabetically to cause smaller diffs
- Remove link references when links are removed
- Documentation improvements
Underneath, everything has changed:
- Published from [Foam monorepo](https://github.com/foambubble/foam)
- Rewrote markdown parsing to use unifiedjs AST
- Rewrote workspace index to user graphlib graph data structures
These changes will enable to make more robust and ambitious releases more frequently 🎉
## [0.1.7] - 2020-07-04
- Support paths to files in subdirectories
@@ -19,7 +35,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
## [0.1.4] - 2020-06-25
- Fix flaky reference block replacement logic that would occasionally leave
trailing fragments in the end of the document ([#3](https://github.com/foambubble/foam-vscode/issues/3))
trailing fragments in the end of the document ([#3](https://github.com/foambubble/foam-vscode/issues/3))
## 0.1.3 - 2020-06-25

View File

@@ -1,5 +1,11 @@
# foam-vscode
[![Version](https://vsmarketplacebadge.apphb.com/version/foam.foam-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)
[![Downloads](https://img.shields.io/visual-studio-marketplace/d/foam.foam-vscode)](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)
[![Installs](https://img.shields.io/visual-studio-marketplace/i/foam.foam-vscode)](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)
[![Ratings](https://img.shields.io/visual-studio-marketplace/r/foam.foam-vscode)](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)
**foam-vscode** is the VS Code extension for [Foam](https://foambubble.github.io/foam).
> foam-vscode doesn't do much on it's own. To learn how to use it, read [Foam documentation](https://foambubble.github.io/foam) and the [Getting started](https://foambubble.github.io/foam/#getting-started) guide.

View File

@@ -4,7 +4,7 @@
"description": "Generate markdown reference lists from wikilinks in a workspace",
"author": "Jani Eväkallio",
"repository": "https://github.com/foambubble/foam",
"version": "0.1.7",
"version": "0.2.0",
"license": "MIT",
"publisher": "foam",
"engines": {
@@ -49,6 +49,6 @@
"vscode-test": "^1.3.0"
},
"dependencies": {
"foam-core": "^0.1.1"
"foam-core": "^0.2.0"
}
}

View File

@@ -1,19 +1,15 @@
<p class="github-only">
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
👋 <b>Hello friend! Looks like you're reading this page on GitHub. Please go to the 👉<a href="https://foambubble.github.io/foam">rendered Foam Workspace</a> for an improved experience! </b>
</p>
👋 **Hello friend! Looks like you're reading this page on GitHub. Please go to the 👉[rendered Foam Workspace](https://foambubble.github.io/foam) for an improved experience!**
👀*This is an early stage project under rapid development. For updates follow [@jevakallio](https://twitter.com/jevakallio) on Twitter, or join the [Foam community Discord](https://discord.gg/rtdZKgj)! 💬*
<p class="github-only">
👀<i>This is an early stage project under rapid development. For updates follow <a href="https://twitter.com/jevakallio" target="_blank">@jevakallio</a> on Twitter, or join the <a href="https://discord.gg/rtdZKgj" target="_blank">Foam community Discord</a>! 💬</i>
</p>
# Foam
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-19-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
**Foam** is a personal knowledge management and sharing system inspired by [Roam Research](https://roamresearch.com/), built on [Visual Studio Code](https://code.visualstudio.com/) and [GitHub](https://github.com/).
You can use **Foam** for organising your research, keeping re-discoverable notes, writing long-form content and, optionally, publishing it to the web.
@@ -82,6 +78,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<tr>
<td align="center"><a href="https://styfle.dev/"><img src="https://avatars1.githubusercontent.com/u/229881?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Steven</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=styfle" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/Georift"><img src="https://avatars2.githubusercontent.com/u/859430?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Tim</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Georift" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/sauravkhdoolia"><img src="https://avatars1.githubusercontent.com/u/34188267?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Saurav Khdoolia</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=sauravkhdoolia" title="Documentation">📖</a></td>
<td align="center"><a href="https://anku.netlify.com/"><img src="https://avatars1.githubusercontent.com/u/22813027?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Ankit Tiwari</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=anku255" title="Documentation">📖</a> <a href="https://github.com/foambubble/foam/commits?author=anku255" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/ayushbaweja"><img src="https://avatars1.githubusercontent.com/u/44344063?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Ayush Baweja</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=ayushbaweja" title="Documentation">📖</a></td>
</tr>
</table>

2970
yarn.lock

File diff suppressed because it is too large Load Diff