github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-26 19:53:59 -05:00
Code Issues Projects Releases Packages Wiki Activity
4315 commits 39 branches 47 tags 112 MiB
Commit graph

254 commits

Author SHA1 Message Date
Philip Molares
a15722b864 Documentation: Add toggleable dark theme 
The dark theme is mostly built on top of the mkdocs slate theme.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
Co-Authored-by: Tilman Vatteroth <git@tilmanvatteroth.de>

(cherry picked from commit 60251d89ee)
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-04-25 12:50:02 +02:00
Renovate Bot
3e2ab14c35
Update dependency mkdocs-material to v7.1.2 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-04-18 22:14:30 +00:00
David Mehren
32d9f21630
Merge pull request #1141 from hedgedoc/mediaBackend/webDAV 2021-04-18 22:22:28 +02:00
Philip Molares
2d86b149a0 Documentation: Add WebDAV media guide 
This explains how to use the WebDAV media backend both in general and with a NextCloud in particular.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-04-18 21:54:40 +02:00
Philip Molares
091d6ee9b4 Add dev docs about notes 
fixes #864

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-04-15 22:20:27 +02:00
Renovate Bot
db7928b389
Update dependency mkdocs-material to v7.1.1 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-04-13 19:54:24 +00:00
Yannick Bungers
429eff4411
Merge pull request #1066 from hedgedoc/docs/hfm 2021-03-31 21:53:28 +02:00
Renovate Bot
5dc1a4bf7b
Update dependency mkdocs-material to v7.1.0 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-03-29 21:12:07 +00:00
Philip Molares
c4e5ffbe7a Docs: Add footnotes extension 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-03-28 22:54:56 +02:00
Yannick Bungers
25bdbf647a
Merge pull request #1032 from hedgedoc/docs/authentication 
Add dev docs about user profiles and authentication
 2021-03-28 22:41:12 +02:00
Renovate Bot
13db168565
Update dependency mkdocs-material to v7.0.7 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-03-28 14:19:41 +00:00
Philip Molares
60f73a5c84 Docs: Add hedgedoc flavored markdown reference 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-03-25 22:33:07 +01:00
David Mehren
97525377c7
Add dev docs about user profiles and authentication 
Closes #463
Closes #451
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-03-25 21:51:17 +01:00
David Mehren
7775b0a288
Merge pull request #1050 from hedgedoc/fix/devDocs 
Docs: Fix dev doc 'documentation'
 2021-03-25 20:25:48 +01:00
David Mehren
6e03f876db
Merge pull request #1033 from hedgedoc/docs/delete_revisions 2021-03-24 22:15:27 +01:00
Philip Molares
db9d42e7f3 Docs: Fix dev doc 'documentation' 
Fix typos
Rewrite 'Deployment' paragraph. We currently don't and probably won't use Messor Structor.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-03-24 20:32:56 +01:00
Philip Molares
bd9235c5c9 DevDocs: Add explanations for new config modules 
The new config modules `customization` and `external-services` are explained in the dev doc overview of all config modules now.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-03-21 20:08:13 +01:00
David Mehren
c01eb61f19
Add dev docs about deleting notes & revisions 
Fixes #560

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-03-21 17:45:45 +01:00
Philip Molares
b5575bbebe MediaService: Remove allowedMimeType application/pdf 
Uploading PDFs does not work with imgur and therefore HedgeDoc should not offer that.

See #533

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-03-15 22:41:40 +01:00
Yannick Bungers
7183d1fabb
Merge pull request #1021 from hedgedoc/publicApi/listMediaUpload 
PublicAPI: Add GET /me/media
 2021-03-15 20:26:59 +01:00
Yannick Bungers
ef352a1313 Add GET /me/media 
Returns all media files uploaded by the authenticated user.

Signed-off-by: Yannick Bungers <git@innay.de>
 2021-03-14 17:47:16 +01:00
Renovate Bot
a1afb16e96
Update dependency mkdocs-material to v7.0.6 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-03-14 14:36:58 +00:00
Renovate Bot
209a0b6db3
Update dependency mkdocs-material to v7.0.5 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-03-07 19:04:16 +00:00
Philip Molares
48052c609f Docs: Add Azure, Filesystem, Imgur and S3 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-03-06 17:12:14 +01:00
Philip Molares
eb7e6b55eb DBSchema: Add fileUrl to media_upload table 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-02-27 22:03:09 +01:00
Yannick Bungers
e351d8557a Docs: Add description for special groups 
Signed-off-by: Yannick Bungers <git@innay.de>
 2021-02-27 14:16:29 +01:00
Renovate Bot
2e949175e8
Update dependency mkdocs-material to v7.0.3 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-02-26 16:08:02 +00:00
Renovate Bot
906bf7d321
Update dependency mkdocs-material to v7 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-02-25 19:21:18 +00:00
Yannick Bungers
b7e188cec2 Rename viewcount to viewCount for compliance 
Signed-off-by: Yannick Bungers <git@innay.de>
 2021-02-22 23:36:44 +01:00
David Mehren
5fac0db8a6
Document supported databases in 2.0 
Closes #447

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-02-19 12:50:16 +01:00
David Mehren
443f58e39d
Add intention of 2.0 development docs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-02-19 12:43:55 +01:00
Yannick Bungers
f8e07f6940 Add relation between User and Group 
This represents the users which are members of this group

Signed-off-by: Yannick Bungers <git@innay.de>
 2021-02-18 22:25:52 +01:00
Philip Molares
14ec1ca120 Docs: Add interface documentation for the toolbar 
This documentation explains HedgeDoc's toolbar to new users.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-02-16 20:59:03 +01:00
Renovate Bot
7b21e078f7
Update dependency mkdocs-material to v6.2.8 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-02-12 22:11:16 +00:00
Philip Molares
c0e797bca6 Dev Docs: Add configuration to navigation 
This makes it possible to access the developer documentation about configuration code.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-02-05 23:12:52 +01:00
Philip Molares
7cdb40585e Dev Docs: Add configuration documentation 
This explains how the configuration code works and give some hints on what do look out for while working on the configuration code.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-02-05 23:08:32 +01:00
David Mehren
763f67d5fb
Merge pull request #801 from hedgedoc/feature/history 2021-02-05 21:30:52 +01:00
David Mehren
d4dcae7d79
Update docs with hint about 2.0 development 
Replace the old docs index page with a hint where the (for now) 'real'
docs can be found and that HedgeDoc 2.0 is still in development.

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-02-04 21:55:27 +01:00
Philip Molares
b76fa91a3c History: Add HistoryEntry 
With this the backend now can hold a history entry.
Also included in this commit are some minor changes to tests and services so they can still work.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-02-04 21:50:14 +01:00
David Mehren
55703e0aec
Delete old docs not relevant for 2.x 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-02-04 21:47:04 +01:00
Renovate Bot
34de07fbc7
chore(deps): update dependency mkdocs-material to v6.2.7 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-02-01 21:06:50 +00:00
Renovate Bot
c39d159cf2
Update dependency mkdocs-material to v6.2.6 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-01-27 17:23:14 +00:00
Renovate Bot
fa235f6fe1
Update dependency pymdown-extensions to v8.1.1 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-01-26 01:46:17 +00:00
Philip Molares
0a3247492a auth: Add cron to clean old tokens 
Rename AuthToken.identifier to label

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-25 21:30:04 +01:00
Philip Molares
599fe57ec6 tokens: Add token creation 
Fix token deletion
Update plantuml docs
Add token validUntil and lastUsed fields

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-25 21:30:02 +01:00
Philip Molares
0bd7a8f4bc db-schema: updates plantuml 
adds identifier and createdAt to AuthToken
renames authToken in User to authTokens

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-25 21:29:52 +01:00
Yannick Bungers
17ceb9c31f Removed special table name in Note object 
and changed table names in plantuml file

Signed-off-by: Yannick Bungers <git@innay.de>
 2021-01-23 22:26:49 +01:00
Renovate Bot
c4fbe53a51
Update dependency mkdocs-material to v6.2.5 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-01-17 10:38:44 +00:00
David Mehren
4a1bec8eec
Move note permission route under metadata 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-10 20:25:28 +01:00
Renovate Bot
01b44082f3
Update dependency mkdocs-material to v6.2.4 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-01-10 19:09:49 +00:00
David Mehren
e15fb2c8a3
Merge branch 'develop' into develop 2021-01-10 18:04:32 +01:00
David Mehren
ffce2de2db
Merge branch 'develop' into docs/cherrypickHistory 2021-01-10 17:52:49 +01:00
Philip Molares
6d5710a917 Fix some typos in history.md 
(cherry picked from commit 0195d074a8)
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-09 12:35:51 +01:00
Simon C
4559d52d52 docs: Fix indentation of code 2021-01-08 14:58:01 +01:00
Tilman Vatteroth
0c56466dc1
Change year in copyright to 2021 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2021-01-06 22:10:19 +01:00
Tilman Vatteroth
bc777a2369
Add license headers 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2021-01-06 14:07:34 +01:00
Tilman Vatteroth
f9fdea36ca
Several theme changes (#659) 
* Several theme changes

- Add max width of 1440px
- Rename css file
- Fix edit button
- Add local Roboto font

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
(cherry picked from commit 5bdb392413)
 2021-01-06 13:59:14 +01:00
Philip Molares
6896daa62a added reuse information 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-05 22:12:38 +01:00
Tilman Vatteroth
4b7318ca33
Move docs into subdirectory to make mkdocs work in a subdirectory 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

(cherry picked from commit eaeb88401d)
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-05 21:09:18 +01:00
Yannick Bungers
8a6e81e1c8
Merge branch 'develop' into public-api-uploads 2020-10-30 22:46:08 +01:00
David Mehren
241a577a02
DB Schema: Make layout pretty 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 22:21:45 +02:00
David Mehren
b9dfd880f7
Note.alias should be optional in db schema 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 22:21:42 +02:00
David Mehren
b9279a5d20
Add note metadata to db schema 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 22:21:41 +02:00
David Mehren
b7195c563c
Public API: Cleanup history schemas 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 22:20:00 +02:00
David Mehren
cfe8169fc2
Public API: NoteRevisionsMetadata is not an array 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 22:20:00 +02:00
David Mehren
a4ac295ada
Public API: Remove PUT /notes/{note}/metadata 
The note metadata will be automatically extracted from the note content and cannot be updated separately.

Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 22:19:59 +02:00
David Mehren
7adcad2ce6
Public API: Fix PUT /notes/{note}/permissions response 
This route should return a full `NotePermissions` object instead of only `NotePermissionsUpdate`

Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 22:19:14 +02:00
David Mehren
a640dea1aa
Public API: Update description of /notes/{note} POST and PUT routes. 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 22:19:14 +02:00
David Mehren
67633c375d
Public API: Successful POST requests should result in a 201. 
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 22:19:13 +02:00
David Mehren
b63593aa8b
Public API: Simplify PUT /me/history/{note} 
Previously, one had to send a complete `NoteMetadata` object when updating the pinned status of a note. A new `HistoryUpdateObject` type was introduced, that only contains the pinned status boolean.

Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 22:19:13 +02:00
David Mehren
2be1defd7a
Public API: Split-out a /notes/{note}/permissions route to set only permissions 
Previously, the metadata route was used to both update note metadata (like title, description and tags) and the permissions. Additionally, one had to send many unchangeable properties. In this commit, a /notes/{note}/permissions route is introduced, that only changes permissions. Additionally, PUT /notes/{note}/metadata now needs only the properties that are actually changeable.

Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
 2020-10-24 22:19:13 +02:00
David Mehren
4a975dcca2
Public API: Add routes to get uploads by user or note 
Co-authored-by: Yannick Bungers <git@innay.de>
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-24 21:48:29 +02:00
David Mehren
a728866ebb
Public API: Add media deletion 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-17 21:55:05 +02:00
David Mehren
16b5f3a5c8
Use POST /media for file upload 
The old `/media/upload` subpath does not follow the convention of REST APIs.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-17 20:58:10 +02:00
David Mehren
e0f8031fab
Public API: Update /media/upload route with supported content-types 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-17 20:55:48 +02:00
David Mehren
f3e093c715
Do not save file extension as a separate field. 
It turned out that saving the file extension in a separate field is not necessary. Instead, the extension is saved in the complete filename in the `id` field.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-17 19:58:22 +02:00
David Mehren
0a0732049a
DB Schema: Add MediaUpload entity 
MediaUpload stores the uploading user, the note the media was uploaded to and backend data.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-17 19:58:22 +02:00
David Mehren
b0b9b75e65
Public API: /media/upload returns the URL of the uploaded file 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-10-17 19:58:22 +02:00
Yannick Bungers
e86898ce18 Fixes types of timestamps and property name 
Signed-off-by: Yannick Bungers <git@innay.de>
 2020-10-01 13:11:47 +02:00
David Mehren
4f5bb75766
Public API spec: Update NoteRevisionsMetadata and timestamp definition 
NoteRevisionsMetadata is an array containing revision data and not an object with a single property containing an array.
Revision timestamps are ISO strings, not UNIX timestamps.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-09-25 21:37:39 +02:00
David Mehren
99dccc0567
RevisionEntity: Change primary key type from UUID to number 
The precision of sqlites datetime() timestamp is only one second (see https://www.sqlite.org/lang_datefunc.html). Therefore we could not order revisions of one note that were created in the same second. To remedy this, the primary key was changed to a monotonically increasing number, which solves the ordering problem.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-09-25 21:37:39 +02:00
David Mehren
99f44f2551
Reverse cardinality of owner relationship 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-09-25 21:37:34 +02:00
Nicolas Lenz
110b9cb077 Update db schema layouting 
Previously, single dashes were used for associatons, which makes PlantUML layout all of them in an horizontal line. I changed that to two dashes so that PlantUML uses normal layouting. I think that is far clearer.

(See https://plantuml.com/class-diagram for more on layouting)

Signed-off-by: Nicolas Lenz <nicolas@eisfunke.com>
 2020-08-29 18:42:28 +02:00
Yannick Bungers
91200cb3b3
Removed unnecessary objects and flattened updateTime 
Signed-off-by: Yannick Bungers <git@innay.de>
 2020-08-20 19:43:17 +02:00
Yannick Bungers
3f6fe71bab
Fixed Typos, removed unnecessary type: object 
and fixed copy paste errors in descriptions

Signed-off-by: Yannick Bungers <git@innay.de>
 2020-08-20 19:43:17 +02:00
Yannick Bungers
7f00c87c68
Added GET /me/history/{note} to get data for updating history 
Signed-off-by: Yannick Bungers <git@innay.de>
 2020-08-20 19:43:16 +02:00
David Mehren
2398499f5d
Rename openapi.yml to public_api.yml 2020-08-20 19:43:16 +02:00
Yannick Bungers
0ec8d61669
Added serverVersion to status by using SemVer 
Signed-off-by: Yannick Bungers <git@innay.de>
 2020-08-20 19:43:16 +02:00
Erik Michelson
71158f93dc
Reorganized openapi.yml for external API structure 
As this document should contain the details of the stable external API, it was refactored and cleaned up.

Co-Authored-By: David Mehren <dmehren1@gmail.com>
Co-Authored-By: Yannick Bungers <git@innay.de>
Co-Authored-By: Philip Molares <philip.molares@udo.edu>
 2020-08-20 19:43:16 +02:00
Erik Michelson
7d20e97348
Added entries for image proxying and registering 
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
 2020-08-20 19:43:16 +02:00
Philip Molares
74421e7264
server tag is now called backend 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2020-08-20 19:43:16 +02:00
Philip Molares
8f0761af96
/me is now a put and not a post since it's an update method 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2020-08-20 19:43:16 +02:00
Philip Molares
4d424842e6
fixed typo 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2020-08-20 19:43:15 +02:00
Philip Molares
7dbadd2d0b
descriptions always end with a dot 
summaries never end with a dot

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2020-08-20 19:43:15 +02:00
Philip Molares
4c11b81dfb
the api doc is now referring to the backend as such and not as system und CodiMD instance 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2020-08-20 19:43:15 +02:00
Philip Molares
3561da0457
/config is now tagged as server to 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2020-08-20 19:43:15 +02:00
Philip Molares
3cb60fbc11
moved the /history endpoints to /me/history 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2020-08-20 19:43:15 +02:00
Philip Molares
8cae3f3c07
user is now always explicitly currently logged-in user 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2020-08-20 19:43:15 +02:00
Philip Molares
f6b26b5d77
base name now is /api/v2/ 
this change makes sense, because v2 client should still be able to call /api/v2/ on v2.1 servers

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2020-08-20 19:43:15 +02:00
Philip Molares
7207602c81
fixed typo 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2020-08-20 19:43:15 +02:00