Skip to content

Commit

Permalink
update docs guides
Browse files Browse the repository at this point in the history
  • Loading branch information
vict0rsch committed Nov 28, 2023
1 parent b49702d commit 3eb7ea9
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 5 deletions.
23 changes: 19 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ PaperMemory is designed to be a fast, automated and user-friendly in-browser ref
- :fontawesome-solid-wand-magic-sparkles:{ .lg .middle } __Parse papers you open automatically__


Papers are stored in your Memory, you can them search them, tag them, take personal notes etc. This is all one click away from your browser's extension store (:fontawesome-brands-chrome: Chrome / :simple-brave: Brave / :fontawesome-brands-firefox-browser: Firefox / :fontawesome-brands-edge: Edge).
Papers are stored in your Memory automatically, without a click. You can then search them, tag them, take personal notes etc.

See the main features and get PaperMemory from your browser's extension store (:fontawesome-brands-chrome: Chrome / :simple-brave: Brave / :fontawesome-brands-firefox-browser: Firefox / :fontawesome-brands-edge: Edge):

[:octicons-arrow-right-24: Getting started](getting-started.md)

Expand All @@ -41,10 +43,23 @@ PaperMemory is designed to be a fast, automated and user-friendly in-browser ref

---

- :octicons-share-android-16:{ .lg .middle } __You live in your browser? So do your papers__


Share papers to your favorite apps by copying:

* a :tabler-math-function: **BibTex entry** for :simple-overleaf: Overleaf
* a :material-language-markdown-outline: **Markdown link** `[title](url)` link for :simple-github: Github, :material-file-document-outline: HackMD or :simple-notion: Notion
* a :tabler-device-desktop-code: **HyperText link** for :octicons-mail-24: emails, :simple-googledocs: Google Docs, :simple-slack: Slack, etc.

[:octicons-arrow-right-24: Memory buttons](getting-started.md#memory)

---

- :fontawesome-solid-file-code:{ .lg .middle } __Discover code repositories__


Using the PapersWithCode API, PaperMemory will store code repositories with papers in your Memory.
Using the PapersWithCode API, PaperMemory will match code repositories with papers in your Memory.

[:octicons-arrow-right-24: Code discovery](features.md#code-discovery)

Expand All @@ -53,7 +68,7 @@ PaperMemory is designed to be a fast, automated and user-friendly in-browser ref
- :simple-arxiv:{ .lg .middle } __Enhance ArXiv.org__


Download the paper directly to your PaperMemoryStore, see the publication venue, copy a markdown link `[title](url)` or a BibTex entry.
Display the actual pubication venue of published papers, a link to the code repository, copy the BibTex entry etc.

[:octicons-arrow-right-24: Arxiv Enhancements](features.md#arxiv-enhancements)

Expand All @@ -62,7 +77,7 @@ PaperMemory is designed to be a fast, automated and user-friendly in-browser ref
- :material-square-root-box:{ .lg .middle } __Instantly copy `.bib`-compatible bibliography entries__


Export papers as BibTex entries from the extension, or group exports by tag. You can even use PaperMemory to update the ArXiv entries of a stand-alone `.bib` file.
Export a paper's BibTex entry directly from the extension, or bulk export BibTex entries by paper tag. You can even use PaperMemory to update the ArXiv entries of a stand-alone `.bib` file.

[:octicons-arrow-right-24: Bibliography tools](features.md#bibliography-tools)

Expand Down
5 changes: 4 additions & 1 deletion docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
}

.demo-gif {
max-width: 600px !important;
max-width: 650px !important;
margin: 0 2rem;
width: 100%;
}
Expand All @@ -48,3 +48,6 @@
display: flex;
align-items: center;
}
img {
border-radius: 8px;
}
Binary file modified extra/imgs/guide-arrows.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified extra/imgs/guide-memory.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,15 @@ markdown_extensions:
- attr_list
- def_list
- md_in_html
- pymdownx.caret
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tilde
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
Expand Down

0 comments on commit 3eb7ea9

Please sign in to comment.