Skip to content

Commit

Permalink
Scribe v0.1.1 (#5)
Browse files Browse the repository at this point in the history
* feat: added readme file

* feat: search support and bug fixes (#4)
  • Loading branch information
HoaX7 authored Sep 18, 2024
1 parent 5b8bb05 commit f6a760e
Show file tree
Hide file tree
Showing 38 changed files with 935 additions and 77 deletions.
10 changes: 2 additions & 8 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ on:

jobs:
release:
permissions:
contents: write
strategy:
fail-fast: false
matrix:
Expand All @@ -28,13 +30,6 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4

# for projects that use labels and PRs,
# try https://github.com/mikepenz/release-changelog-builder-action instead
# TODO: use API to collect commit messages
- name: Build Changelog
id: build_changelog
run: echo "changelog=- ADD CHANGELOG" >> $GITHUB_OUTPUT

- name: Node.js setup
uses: actions/setup-node@v4
# NOTE: enterprise developers may hard code a version
Expand Down Expand Up @@ -67,7 +62,6 @@ jobs:
tagName: app-v__VERSION__
releaseName: Scribe v__VERSION__
releaseBody: |
${{steps.build_changelog.outputs.changelog}}
See the assets to download this version and install.
releaseDraft: true
prerelease: false
1 change: 1 addition & 0 deletions app/docs/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<h1 class="mt-8">Scribe v0.1.0</h1><p>A Simple opensource note taking app perfect for quick notes or detailed plans, stay on top of your day and never lose track of your ideas again.</p><p>This markdown was created using scribe.</p><h2 class="mt-8">Quick notes</h2><p>Press <code class="px-1 bg-gray-200 rounded">Ctrl+space</code>&nbsp;from anywhere to jot down notes without having to worry about where to save them. The app will automatically save the contents in a <code class="px-1 bg-gray-200 rounded">shortnotes.md</code>&nbsp;in the selected directory.</p><h1 class="mt-8">Settings</h1><p>All notes by default are saved in the installation path under a <code class="px-1 bg-gray-200 rounded">docs</code>&nbsp;folder.</p><p>You can modify the save path by clicking on <code class="px-1 bg-gray-200 rounded">File &gt; Settings</code>.</p><p><strong>Note: You must move the files manually to the new save directory.</strong></p><h1 class="mt-8">Key features</h1><ul class="px-2 mx-2 my-2"><li class="my-1"><p>Built for speed with rust.</p></li><li class="my-1"><p>Close the app and take notes from anywhere.</p></li><li class="my-1"><p>Markdown shortcuts make it easy to format the text while typing.</p><p>To test that, start a new line and type <code class="px-1 bg-gray-200 rounded">#</code> followed by a space to get a heading. Try <code class="px-1 bg-gray-200 rounded">#</code>, <code class="px-1 bg-gray-200 rounded">##</code>, <code class="px-1 bg-gray-200 rounded">###</code>, <code class="px-1 bg-gray-200 rounded">####</code>, <code class="px-1 bg-gray-200 rounded">#####</code>, <code class="px-1 bg-gray-200 rounded">######</code> for different levels.</p></li><li class="my-1"><p>You can also try <code class="px-1 bg-gray-200 rounded">&gt;</code> for blockquotes, <code class="px-1 bg-gray-200 rounded">*</code>, <code class="px-1 bg-gray-200 rounded">-</code> or <code class="px-1 bg-gray-200 rounded">+</code> for bullet lists, or <code class="px-1 bg-gray-200 rounded">`foobar`</code> to highlight code, <code class="px-1 bg-gray-200 rounded">~~tildes~~</code> to strike text, or <code class="px-1 bg-gray-200 rounded">==equal signs==</code> to highlight text,&nbsp;<code class="px-1 bg-gray-200 rounded">(c)</code> to see how it’s converted to a proper © character. You can also try <code class="px-1 bg-gray-200 rounded">-&gt;</code>, <code class="px-1 bg-gray-200 rounded">&gt;&gt;</code>, <code class="px-1 bg-gray-200 rounded">1/2</code>, <code class="px-1 bg-gray-200 rounded">!=</code>, or <code class="px-1 bg-gray-200 rounded">--</code>,&nbsp;<code class="px-1 bg-gray-200 rounded">**</code>&nbsp;for bold and&nbsp;<code class="px-1 bg-gray-200 rounded">_Italic_</code>&nbsp;<em>for italic.</em></p></li><li class="my-1"><p>An inline toolbar is also available when you select text.</p></li></ul><h1 class="mt-8">Roadmap</h1><ul class="px-2 mx-2 my-2"><li class="my-1"><p>Integration with notion.</p></li></ul>
14 changes: 14 additions & 0 deletions app/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions app/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
"@tiptap/extension-task-item": "^2.6.6",
"@tiptap/extension-task-list": "^2.6.6",
"@tiptap/extension-text-style": "^2.6.6",
"@tiptap/extension-typography": "^2.6.6",
"@tiptap/extension-underline": "^2.6.6",
"@tiptap/pm": "^2.6.6",
"@tiptap/starter-kit": "^2.6.6",
Expand Down
Loading

0 comments on commit f6a760e

Please sign in to comment.