Skip to content

Commit

Permalink
Update website
Browse files Browse the repository at this point in the history
  • Loading branch information
@laurent22
laurent22 committed Jan 11, 2020
1 parent 0a13c98 commit cd284f7
Show file tree
Hide file tree
Showing 10 changed files with 640 additions and 565 deletions.
32 changes: 20 additions & 12 deletions docs/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -332,18 +332,6 @@
</li>
</ul>
</div>
<blockquote>
<p>joplin@1.0.0 tsc /Users/laurent/src/joplin<br>
tsc</p>
</blockquote>
<p>TSFILE: /Users/laurent/src/joplin/ReactNativeClient/lib/JoplinServerApi.js<br>
TSFILE: /Users/laurent/src/joplin/ReactNativeClient/lib/JoplinServerApi.js.map<br>
TSFILE: /Users/laurent/src/joplin/ElectronClient/app/lib/JoplinServerApi.js<br>
TSFILE: /Users/laurent/src/joplin/ElectronClient/app/lib/JoplinServerApi.js.map<br>
TSFILE: /Users/laurent/src/joplin/ElectronClient/app/gui/ShareNoteDialog.js<br>
TSFILE: /Users/laurent/src/joplin/ElectronClient/app/gui/ShareNoteDialog.js.map<br>
TSFILE: /Users/laurent/src/joplin/CliClient/build/lib/JoplinServerApi.js<br>
TSFILE: /Users/laurent/src/joplin/CliClient/build/lib/JoplinServerApi.js.map</p>
<h1>Joplin API<a name="joplin-api" href="#joplin-api" class="heading-anchor">🔗</a></h1>
<p>When the Web Clipper service is enabled, Joplin exposes a <a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST API</a> which allows third-party applications to access Joplin's data and to create, modify or delete notes, notebooks, resources or tags.</p>
<p>In order to use it, you'll first need to find on which port the service is running. To do so, open the Web Clipper Options in Joplin and if the service is running it should tell you on which port. Normally it runs on port <strong>41184</strong>. If you want to find it programmatically, you may follow this kind of algorithm:</p>
Expand Down Expand Up @@ -528,6 +516,11 @@ <h2>Properties<a name="properties" href="#properties" class="heading-anchor">
<td></td>
</tr>
<tr>
<td>is_shared</td>
<td>int</td>
<td></td>
</tr>
<tr>
<td>body_html</td>
<td>text</td>
<td>Note body, in HTML format</td>
Expand Down Expand Up @@ -643,6 +636,11 @@ <h2>Properties<a name="properties-1" href="#properties-1" class="heading-anchor"
<td>text</td>
<td></td>
</tr>
<tr>
<td>is_shared</td>
<td>int</td>
<td></td>
</tr>
</tbody>
</table>
<h2>GET /folders<a name="get-folders" href="#get-folders" class="heading-anchor">🔗</a></h2>
Expand Down Expand Up @@ -734,6 +732,11 @@ <h2>Properties<a name="properties-2" href="#properties-2" class="heading-anchor"
<td>int</td>
<td></td>
</tr>
<tr>
<td>is_shared</td>
<td>int</td>
<td></td>
</tr>
</tbody>
</table>
<h2>GET /resources<a name="get-resources" href="#get-resources" class="heading-anchor">🔗</a></h2>
Expand Down Expand Up @@ -803,6 +806,11 @@ <h2>Properties<a name="properties-3" href="#properties-3" class="heading-anchor"
<td>int</td>
<td></td>
</tr>
<tr>
<td>is_shared</td>
<td>int</td>
<td></td>
</tr>
</tbody>
</table>
<h2>GET /tags<a name="get-tags" href="#get-tags" class="heading-anchor">🔗</a></h2>
Expand Down
18 changes: 18 additions & 0 deletions docs/changelog/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,24 @@
</ul>
</div>
<h1>Joplin changelog<a name="joplin-changelog" href="#joplin-changelog" class="heading-anchor">🔗</a></h1>
<h2><a href="https://github.com/laurent22/joplin/releases/tag/v1.0.177">v1.0.177</a> - 2019-12-30T14:40:40Z<a name="v1-0-177-https-github-com-laurent22-joplin-releases-tag-v1-0-177-2019-12-30t14-40-40z" href="#v1-0-177-https-github-com-laurent22-joplin-releases-tag-v1-0-177-2019-12-30t14-40-40z" class="heading-anchor">🔗</a></h2>
<p>This is to test the Electron framework upgrade and the switch to a separate note renderer. If you find any bug please report on the forum or GitHub tracker.</p>
<ul>
<li>New: Allow exporting a note as HTML</li>
<li>Improved: Extract note renderer to separate package (<a href="https://github.com/laurent22/joplin/issues/2206">#2206</a>)</li>
<li>Improved: Better handling of resource download errors, and added resource info to sync status screen</li>
<li>Improved: Update Katex to 0.11.1 (<a href="https://github.com/laurent22/joplin/issues/2201">#2201</a>)</li>
<li>Improved: Improved Nextcloud API error handling</li>
<li>Improved: Updated OneDrive login to remove webview dependency</li>
<li>Improved: Decrypt notes that are meant to be shared</li>
<li>Improved: Make it easier to view early errors when the app starts</li>
<li>Improved: Upgrade to Electron 7</li>
<li>Improved: Render note using iframe instead of deprecated webview</li>
<li>Fixed: Fix Goto Anything scrolling issue (<a href="https://github.com/laurent22/joplin/issues/2199">#2199</a>) (<a href="https://github.com/laurent22/joplin/issues/2122">#2122</a>)</li>
<li>Fixed: Prevent app from crashing when pressing focus shortcut from search bar (<a href="https://github.com/laurent22/joplin/issues/2157">#2157</a>)</li>
<li>Fixed: Handle WebDAV servers that do not return a last modified date (fixes <a href="http://mail.ru">mail.ru</a>) (<a href="https://github.com/laurent22/joplin/issues/2091">#2091</a>)</li>
<li>Fixed: Fix notifications on Windows 7 (<a href="https://github.com/laurent22/joplin/issues/2144">#2144</a>)</li>
</ul>
<h2><a href="https://github.com/laurent22/joplin/releases/tag/v1.0.176">v1.0.176</a> - 2019-12-14T10:36:44Z<a name="v1-0-176-https-github-com-laurent22-joplin-releases-tag-v1-0-176-2019-12-14t10-36-44z" href="#v1-0-176-https-github-com-laurent22-joplin-releases-tag-v1-0-176-2019-12-14t10-36-44z" class="heading-anchor">🔗</a></h2>
<ul>
<li>New: Add ability to share a note publicly using Nextcloud (<a href="https://github.com/laurent22/joplin/issues/2173">#2173</a>)</li>
Expand Down
11 changes: 9 additions & 2 deletions docs/gsoc2020/ideas.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ <h1>Information for Students<a name="information-for-students" href="#informatio
<h1>List of ideas<a name="list-of-ideas" href="#list-of-ideas" class="heading-anchor">🔗</a></h1>
<h2>1. Support for multiple profiles<a name="1-support-for-multiple-profiles" href="#1-support-for-multiple-profiles" class="heading-anchor">🔗</a></h2>
<p>The applications should support multiple profiles so that, for example, one can have a &quot;work&quot; profile and a &quot;personal&quot; profile. This will also make it easier to share notes: for example a &quot;work project&quot; profile could be created and shared with co-workers via sync.</p>
<p>We want to offer this feature by allowing the user to select a profile from the app (eg. &quot;work&quot; or &quot;personal&quot;, then switch to it. Switching would be done by restarting the app and loading the selected profile.</p>
<p>We want to offer this feature by allowing the user to select a profile from the app (eg. &quot;work&quot; or &quot;personal&quot;), then switch to it. Switching would be done by restarting the app and loading the selected profile.</p>
<p>Expected Outcome: The user should be able to select a profile and switch to it.</p>
<p>Difficulty Level: Moderate</p>
<p>Platforms: Desktop and/or mobile (at the student's choice)</p>
Expand Down Expand Up @@ -388,7 +388,7 @@ <h2>5. Web client for Nextcloud<a name="5-web-client-for-nextcloud" href="#5-web
<p>Potential Mentor(s):</p>
<p>More info: <a href="https://github.com/laurent22/joplin/issues/228">GitHub: Nextcloud notes integration (Web client)</a></p>
<h2>5. OCR support<a name="5-ocr-support" href="#5-ocr-support" class="heading-anchor">🔗</a></h2>
<p>It is possible to add support for OCR content in Joplin via the [<a href="http://tesseract.projectnaptha.com/">http://tesseract.projectnaptha.com/</a>](Tesseract library). A first step would be to assess the feasibility of this project by integrating the lib in the desktop app and trying to OCR an image. OCR support should be implemented as a service of the desktop app. It would extract the text from the images, and append the content as plain text to the notes.</p>
<p>It is possible to add support for OCR content in Joplin via the <a href="http://tesseract.projectnaptha.com/">Tesseract library</a>. A first step would be to assess the feasibility of this project by integrating the lib in the desktop app and trying to OCR an image. OCR support should be implemented as a service of the desktop app. It would extract the text from the images, and append the content as plain text to the notes.</p>
<p>Expected Outcome: A service on the desktop app that extract text from images and attach it to the note.</p>
<p>Difficulty Level: High</p>
<p>Skills Required: JavaScript</p>
Expand Down Expand Up @@ -421,6 +421,13 @@ <h2>7. Search<a name="7-search" href="#7-search" class="heading-anchor">🔗</a>
<p>Skills Required: JavaScript</p>
<p>Potential Mentor(s):</p>
<p>More info: <a href="https://github.com/laurent22/joplin/issues/1877">Search engine improvements</a></p>
<h2>8. WYSIWYG Editor<a name="8-wysiwyg-editor" href="#8-wysiwyg-editor" class="heading-anchor">🔗</a></h2>
<p>The current editor shows the Markdown text on the left side and the rendered HTML on the right side (a split view). We would like to add another editor option, which would be a WYSIWYG editor, where the user can directly edit formatted text. This would not replace the split view but rather be an alternative editor and the user can choose either split view or WYSIWYG.</p>
<p>Expected Outcome: To add a WYSIWYG editor to the desktop app.</p>
<p>Difficulty Level: High</p>
<p>Skills Required: JavaScript; React</p>
<p>Potential Mentor(s):</p>
<p>More info: <a href="https://discourse.joplinapp.org/t/wysiwyg-editor-in-joplin/2253">WYSIWYG thread on the forum</a></p>

<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/gsoc2020/ideas.md">
Expand Down
2 changes: 1 addition & 1 deletion docs/gsoc2020/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ <h2>Recommended steps<a name="recommended-steps" href="#recommended-steps" class
<ol>
<li>Join the <a href="https://discourse.joplinapp.org">Joplin Forum</a>, introduce yourself, and meet your fellow developers in the <a href="https://discourse.joplinapp.org/c/development">Development category</a></li>
<li>Read Student proposal guidelines and the <a href="https://developers.google.com/open-source/gsoc/resources/manual#student_manual">GSoC Student Manual</a></li>
<li>Take a look at the <a href="https://joplinapp.org/gsoc/ideas.html">list of ideas</a>. You can have you own idea added by posting it in the <a href="https://discourse.joplinapp.org/c/features">Features category</a></li>
<li>Take a look at the <a href="https://joplinapp.org/gsoc2020/ideas.html">list of ideas</a>. You can have you own idea added by posting it in the <a href="https://discourse.joplinapp.org/c/features">Features category</a></li>
<li>Come up with project that you're interested in and discuss it in <a href="https://discourse.joplinapp.org/c/development">Development category</a></li>
<li>Write a first draft and get someone to review it</li>
<li>Remember: you must link to work such as commits in your proposal. A private place will be created wihtinn the forum for that purposes.</li>
Expand Down
Loading

0 comments on commit cd284f7

Please sign in to comment.