Updated docs links

This commit is contained in:
Lauri Ojansivu 2025-06-13 22:36:59 +03:00
parent cc7459b983
commit 4bfc0140be
11 changed files with 241 additions and 37 deletions

204
docs/Features/Emoji.md Normal file
View file

@ -0,0 +1,204 @@
## About markdown changes
Wekan v4.29 changes markdown rendering from [marked](https://github.com/markedjs/marked) to [markdown-it](https://github.com/markdown-it/markdown-it).
## About emoji
With markdown-it, also [markdown-it-emoji](https://github.com/markdown-it/markdown-it-emoji) plugin has been added, supporting [full list of GitHub emojis](https://github.com/markdown-it/markdown-it-emoji/blob/master/lib/data/full.json).
Example emoji code, that you can add for example to card name, card description etc:
```
:rainbow: :thumbsup: :100:
```
That shows emojis :rainbow: :thumbsup: :100:
## About other markdown-it plugins
For markdown-it, there are also other [syntax extensions](https://github.com/markdown-it/markdown-it#syntax-extensions) where some are listed at that markdown-it page, and [others at npmjs.com](https://www.npmjs.org/browse/keyword/markdown-it-plugin).
For example, how to get some [mermaid plugin](https://www.npmjs.com/search?q=markdown-it-mermaid) working so that some syntax works for https://mermaid-js.github.io/mermaid/ ?
## How you could add another plugin
Using newest Ubuntu amd64:
# Meteor 2
### 1. Install git and configure it
```
sudo apt -y install git
git config --global user.name "Yourfirstname Yourlastname"
git config --global user.email email-address-you-use-at-github@example.com
git config --global push.default simple
nano .ssh/config
```
There add your User (GitHub username) and IdentityFile (Your ssh private key. Not public key that has .pub).
For indentation, use one tab.
```
Host *
IdentitiesOnly=yes
Host github.com
Hostname github.com
User xet7
IdentityFile ~/.ssh/id_xet7ed
```
Save and Exit with Ctrl-o Enter Ctrl-x Enter
If you do not have ssh key, create it:
```
ssh-keygen
```
And press Enter about 3 times, until you have private key at `~/.ssh/id_rsa` and public key at `~/.ssh/id_rsa.pub`
Add public key `.pub` to your github account web interface.
Add path to Meteor:
```
nano .bashrc
```
There at bottom add:
```
export PATH=~/.meteor:$PATH
```
Save and Exit with Ctrl-o Enter Ctrl-x Enter
### 2. Create fork of `https://github.com/wekan/wekan` at GitHub web page
```
mkdir repos
cd repos
git clone git@github.com:YourGithubUsername/wekan.git
cd wekan
```
### 3. Select option 1 to install dependencies, and then Enter.
```
./rebuild-wekan.sh
1
./rebuild-wekan.sh
2
./rebuild-wekan.sh
3
```
That does: 1 install dependencies, 2 builds wekan, 3 starts wekan in development mode with command `meteor`, so it can detect if some file changes and try to rebuild automatically and reload webbroser. But, still sometimes, it may need stopping with Ctrl-c and full build with option 2.
And then [register and login](Adding-users) at http://localhost:4000
### OPTIONAL, NOT NEEDED: 5. Add new plugin package
```
meteor npm install markdown-it-something --save
```
Edit file `wekan/packages/markdown/src-integration.js` and add using that new package, using code example from that new plugin page, or similar like emoji plugin was added.
### 7. Test
Test does that new plugin syntax work, for example in card title, card description etc on other input fields.
### 8. If it works, create pull request
If normal markdown, emoji, and your new added plugin syntax all work, commit your changes:
```
git add --all
git commit -m "Added plugin markdown-it-something."
git push
```
And then at your GitHub for `https://github.com/YOUR-GITHUB-USERNAME/wekan` click `Create pull request`.
# Meteor 3
At 2024-06-26, it looks like from https://nodejs.org/en that Node.js LTS version is 20.15.0 , so change to newest Node.js LTS, delete old Meteor:
```
sudo n 20.15.0
sudo npm -g install npm
cd
rm -rf .meteor
```
Check how to install newest Meteor from Meteor 3 PR at https://github.com/meteor/meteor/pull/13163 , for example:
```
npx meteor@rc
```
Check what branches there are:
```
cd repos/wekan
git branch -a
```
Change to Meteor 3 branch:
```
git checkout feature-meteor3
```
Build wekan:
```
./rebuild-wekan.sh
2
```
If there are errors, try to fix them.
Or try to run wekan:
```
./rebuild-wekan.sh
3
```
# Updating
There are usually updates both for npm packages and Meteor
Updating npm packages:
```
npm update
```
Checking for vulnerable packages:
```
npm audit
```
Fixing vulnerable npm packages by updating to newer packages:
```
npm audit fix
```
If that did not help, use force:
```
npm audit fix --force
```
If that did not help, read links from that `npm audit` command did show, remove deprecated dependencies, update to other maintained dependencies.
Updating to next Meteor release:
```
meteor update
```
Updating to specific Meteor release:
```
meteor update --release METEOR@3.0-rc.4
```
Trying to update all Meteor packages:
```
meteor update --release METEOR@3.0-rc.4 --all-packages
```
Allowing incompatible updates, that may sometime work:
```
meteor update --release METEOR@3.0-rc.4 --all-packages --allow-incompatible-update
```
If you are changing Meteor and Node.js versions, you may need to reset Meteor:
```
meteor reset
```
Or alternatively, delete wekan repo (if you did not need any changes you made), and clone wekan repo again, and then build etc.

View file

@ -79,6 +79,7 @@ If you still have questions, check out the [[FAQ]]!
# Backup # Backup
* [Backup and Restore](Backup/Backup.md) * [Backup and Restore](Backup/Backup.md)
* [Rclone: Store attachments to cloud storage like S3, MinIO, etc](Backup/Rclone.md)
# <a name="Repair"></a>Repair # <a name="Repair"></a>Repair
@ -95,61 +96,60 @@ If you still have questions, check out the [[FAQ]]!
# <a name="MarkdownSyntax"></a>Markdown Syntax # <a name="MarkdownSyntax"></a>Markdown Syntax
* [Wekan Markdown](Wekan-Markdown) * [Wekan Markdown](Features/Wekan-Markdown.md)
* [Emoji](Emoji) * [Emoji](Features/Emoji.md)
* [Mermaid Diagram](Mermaid-Diagram) DOES NOT WORK ANYMORE * [Mermaid Diagram](Features/Mermaid-Diagram.md) DOES NOT WORK ANYMORE
* [Numbered text](Numbered-text) * [Numbered text](Features/Numbered-text.md)
# <a name="LoginAuth"></a>Login Auth # <a name="LoginAuth"></a>Login Auth
* [Automatic login](autologin) * [Automatic login](Login/autologin.md)
* [Disable Password Login](Disable-Password-Login) * [Disable Password Login](Login/Disable-Password-Login.md)
* [Forgot Password](Forgot-Password) * [Forgot Password](Login/Forgot-Password.md)
* [Admin: Impersonate user](Impersonate-user) * [Admin: Impersonate user](Login/Impersonate-user.md)
* [Adding Users](Adding-users) * [Adding Users](Login/Adding-users.md)
* [Active users Presence](https://github.com/wekan/wekan/issues/3734) * [Active users Presence](https://github.com/wekan/wekan/issues/3734)
* [Accounts Lockout: Brute force login protection](Accounts-Lockout) * [Accounts Lockout: Brute force login protection](Login/Accounts-Lockout.md)
* [LDAP](LDAP) * [LDAP](Login/LDAP.md)
* [LDAP AD Simple Auth](LDAP-AD-Simple-Auth) * [LDAP AD Simple Auth](Login/LDAP-AD-Simple-Auth.md)
* [Keycloak](Keycloak) * [Keycloak](Login/Keycloak.md)
* [Google login](Google-login) * [Google login](Login/Google-login.md)
* [Azure](Azure) * [Azure](Login/Azure.md)
* [OAuth2](OAuth2), Auth0, GitLab, RocketChat * [OAuth2](Login/OAuth2.md), Auth0, GitLab, RocketChat
* [Oracle OIM on premise using OAuth2](Oracle-OIM) * [Oracle OIM on premise using OAuth2](Login/Oracle-OIM.md)
* [ADFS 4.0 using OAuth2 and OpenID](ADFS) * [ADFS 4.0 using OAuth2 and OpenID](Login/ADFS.md)
* [Azure AD B2C using OAuth2](B2C) * [Azure AD B2C using OAuth2](Login/B2C.md)
* [Nextcloud](Nextcloud) * [Nextcloud](Login/Nextcloud.md)
* [CAS](CAS) Please test * [CAS](Login/CAS.md) Please test
* [SAML](SAML) Please test * [SAML](Login/SAML.md) Please test
* [Zitadel](Zitadel) * [Zitadel](Login/Zitadel.md)
# <a name="Logs"></a>Metrics, Logs, Stats # <a name="Logs"></a>Metrics, Logs, Stats
* [Metrics](Metrics) * [Metrics](Features/Metrics)
* [Logs](Logs) * [Logs](Features/Logs.md)
* [Stats](Features#stats) * [Stats](Features/Features.md#stats)
# <a name="Integrations"></a>Integrations # <a name="Integrations"></a>Integrations
* [IFTTT](IFTTT) * [IFTTT](ImportExport/IFTTT.md)
* [n8n Wekan docs](https://docs.n8n.io/nodes/n8n-nodes-base.wekan/#example-usage) - [n8n GitHub](https://github.com/n8n-io/n8n) * [n8n Wekan docs](https://docs.n8n.io/nodes/n8n-nodes-base.wekan/#example-usage) - [n8n GitHub](https://github.com/n8n-io/n8n)
* [Integrations](Integrations) * [Integrations](ImportExport/Integrations.md)
* [Gogs](https://github.com/wekan/wekan-gogs) * [Gogs](https://github.com/wekan/wekan-gogs)
# <a name="Time"></a>Time # <a name="Time"></a>Time
* [Time Tracking](Time-Tracking) * [Time Tracking](Date/Time-Tracking.md)
* [Gantt Chart](Gantt) * [Gantt Chart](Features/Gantt.md)
* [Due Date](Due-Date) * [Due Date](Date/Due-Date.md)
* [Day of week start](Day-of-week-start) * [Day of week start](Date/Day-of-week-start.md)
* [Calendar](Calendar) * [Calendar](Calendar.md)
# <a name="Features"></a>Features # <a name="Features"></a>Features
* [Multiline](Multiline) * [Multiline](Features/Multiline.md)
* [Linked Cards](Linked-Cards) * [Linked Cards](Features/Linked-Cards.md)
* [Drag Drop](https://github.com/wekan/wekan/wiki/Drag-Drop) on Mobile and Desktop * [Drag Drop](Features/DragDrop/Drag-Drop.md) on Mobile and Desktop
* [Rclone: Store attachments to cloud storage like S3, MinIO, etc](Rclone)
* [Python based features](Python) * [Python based features](Python)
* [Burndown and Velocity Chart](Burndown-and-Velocity-Chart) * [Burndown and Velocity Chart](Burndown-and-Velocity-Chart)
* [Wait Spinners](Wait-Spinners) * [Wait Spinners](Wait-Spinners)