office/klevernotes/README.md

0001 <!--
0002     SPDX-License-Identifier: GPL-2.0-or-later
0003     SPDX-FileCopyrightText: 2022 Louis Schul <schul9louis@gmail.com>
0004 -->
0005
0006 # Klevernotes
0007
0008 KleverNotes is a note taking and management application for your mobile and desktop devices. It uses markdown and allow you to preview your content.
0009
0010 Different Markdown flavors are supported thanks to [Marked.js](https://marked.js.org/#specifications) (more features will come).
0011
0012 **Get involved and join our Matrix channel: [klevernotes:kde.org](https://matrix.to/#/#klevernotes:kde.org)**
0013
0014 ___
0015
0016 ## Screenshots
0017
0018 ### Adaptative
0019 ![Screenshot of Klevernotes main page on desktop](https://cdn.kde.org/screenshots/klevernotes/main_note_desktop.png)
0020 ![Screenshot of Klevernotes main page on mobile](https://cdn.kde.org/screenshots/klevernotes/main_note_mobile.png)
0021 ### Todos for each note
0022 ![Screenshot of Klevernotes todo](https://cdn.kde.org/screenshots/klevernotes/todo_mobile.png)
0023 ### Draw your thoughts !
0024 ![Screenshot of  Klevernotes drawing](https://cdn.kde.org/screenshots/klevernotes/painting.png)
0025 ### Print your note !
0026 ![Screenshot of  Klevernotes print page](https://cdn.kde.org/screenshots/klevernotes/printing.png)
0027
0028 ___
0029
0030 ## Plugins
0031 > A feature that goes beyond the normal scope of Markdown.
0032 > It is considered a 'plugin' and can be enabled/disabled at any time in the settings.
0033 > A plugin is disabled by default.
0034
0035 <details><summary>Available plugins</summary>
0036
0037 ### Note linking
0038 Link your notes together. You can even link them to a specific header !
0039
0040 Use the following syntax to do so :
0041
0042 `[[ Category/Group/Note:# header | displayed name ]]`
0043
0044 ### Syntax highlighting
0045 Highlight your blocks of code !
0046
0047 Use the following syntax to do so :
0048 ```
0049     ```<lang>
0050         code goes here
0051     ```
0052 ```
0053 Replace `<lang>` with the desired language :smile:
0054
0055 #### Supported highlighter:
0056 - [KSyntaxHighlighter](https://invent.kde.org/frameworks/syntax-highlighting)
0057 - [Chroma](https://github.com/alecthomas/chroma)
0058 - [Pygments](https://pygments.org/)
0059
0060 ### Quick emoji
0061 Quickly add emojis to your text !
0062
0063 Use the following syntax to do so :
0064
0065 `:emoji_name:`
0066
0067 You can also choose your preferred tone for the emoji. If a colored variant of the emoji is available, your preferred tone will be used by default.
0068
0069 ### PlantUML
0070 Create diagram with PlantUML.
0071
0072 Use the following syntax to do so :
0073 ```puml
0074 <PlantUML syntax>
0075 ```
0076 or
0077 ```plantuml
0078 <PlantUML syntax>
0079 ```
0080
0081 [More info about PlantUML](https://plantuml.com/)
0082
0083 </details>
0084
0085 ___
0086
0087 ## Get it
0088
0089 Klevernotes is currently in [KDE incubator](https://community.kde.org/Incubator)
0090
0091 You'll need to build the app to test it !
0092
0093 ## Build
0094
0095 **[kdesrc-build](https://invent.kde.org/sdk/kdesrc-build)** would be the best option to build klevernotes and its dependencies easily.
0096
0097
0098 ### ⚠️  Note: This requires building with _QT6_, the default with kdesrc-build. ⚠️
0099
0100 <br>
0101
0102 Arch Linux dependencies:
0103 ```
0104 base-devel extra-cmake-modules cmake qt6-base qt6-declarative qt6-quickcontrols2 qt6-webengine
0105 ```
0106
0107 <br>
0108
0109 Once kdesrc-build is correctly installed on your system:
0110
0111 1. Let's make sure KleverNotes will look good by running:
0112 ```
0113 kdesrc-build kirigami kcoreaddons ki18n breeze plasma-integration qqc2-desktop-style
0114 ```
0115
0116 2. Let's build KleverNotes:
0117 ```
0118 kdesrc-build klevernotes
0119 ```
0120
0121 3. Start it with:
0122 ```
0123 kdesrc-run klevernotes
0124 ```