summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--.github/workflows/node.js.yml6
-rw-r--r--docs/content/guides/reverse-proxy.md (renamed from docs/content/setup/reverse-proxy.md)0
-rw-r--r--docs/content/setup/arch-linux.md5
-rw-r--r--docs/content/setup/getting-started.md10
-rw-r--r--docs/content/setup/index.md8
-rw-r--r--docs/content/setup/kubernetes-helm.md7
-rw-r--r--docs/content/setup/kubernetes.md5
-rw-r--r--docs/content/theme/styles/hedgedoc-custom.css27
-rw-r--r--docs/mkdocs.yml23
-rw-r--r--docs/requirements.txt4
-rw-r--r--package.json6
-rw-r--r--public/js/slide.js99
-rw-r--r--yarn.lock31
13 files changed, 126 insertions, 105 deletions
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
index 60d2c3ed..7a42a311 100644
--- a/.github/workflows/node.js.yml
+++ b/.github/workflows/node.js.yml
@@ -19,7 +19,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Use Node.js 14
- uses: actions/setup-node@v1
+ uses: actions/setup-node@v2
with:
node-version: 14
- name: Get yarn cache directory path
@@ -43,7 +43,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
- uses: actions/setup-node@v1
+ uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
- name: Get yarn cache directory path
@@ -67,7 +67,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
- uses: actions/setup-node@v1
+ uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
- name: Get yarn cache directory path
diff --git a/docs/content/setup/reverse-proxy.md b/docs/content/guides/reverse-proxy.md
index b1e7f32f..b1e7f32f 100644
--- a/docs/content/setup/reverse-proxy.md
+++ b/docs/content/guides/reverse-proxy.md
diff --git a/docs/content/setup/arch-linux.md b/docs/content/setup/arch-linux.md
new file mode 100644
index 00000000..1ffcabf2
--- /dev/null
+++ b/docs/content/setup/arch-linux.md
@@ -0,0 +1,5 @@
+# Arch Linux
+
+HedgeDoc is available in the Arch Linux _community_ repository.
+
+[Link to the package](https://archlinux.org/packages/community/any/hedgedoc/)
diff --git a/docs/content/setup/getting-started.md b/docs/content/setup/getting-started.md
new file mode 100644
index 00000000..41426514
--- /dev/null
+++ b/docs/content/setup/getting-started.md
@@ -0,0 +1,10 @@
+# Getting started
+
+Thank you for choosing HedgeDoc!
+To set up your instance follow these steps:
+
+1. Choose an installation method and follow the instructions
+2. [Configure your reverse proxy](https://docs.hedgedoc.org/guides/reverse-proxy/)
+3. [Configure HedgeDoc](https://docs.hedgedoc.org/configuration/)
+
+Follow us on <a href="http://social.codimd.org/" target="_blank" rel="noreferer noopener">:fontawesome-brands-mastodon:{: .mastodon }Mastodon</a> or <a href="http://social.codimd.org/twitter" target="_blank" rel="noreferer noopener">:fontawesome-brands-twitter:{: .twitter }Twitter</a> for updates.
diff --git a/docs/content/setup/index.md b/docs/content/setup/index.md
deleted file mode 100644
index 253450b7..00000000
--- a/docs/content/setup/index.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# Installation / Upgrading
-You can run HedgeDoc in a number of ways:
-
-- [Docker](docker)
-- [Cloudron](cloudron)
-- [LinuxServer.io (multi-arch docker)](docker-linuxserver)
-- [Heroku](heroku)
-- [Manual setup](manual-setup)
diff --git a/docs/content/setup/kubernetes-helm.md b/docs/content/setup/kubernetes-helm.md
new file mode 100644
index 00000000..67a27e82
--- /dev/null
+++ b/docs/content/setup/kubernetes-helm.md
@@ -0,0 +1,7 @@
+# Helm Chart
+
+You can deploy HedgeDoc on your Kubernetes cluster using `helm`.
+
+[HedgeDoc Helm Chart by nicholaswilde on Artifact Hub](https://artifacthub.io/packages/helm/nicholaswilde/hedgedoc)
+
+[Source Code](https://nicholaswilde.github.io/helm-charts/)
diff --git a/docs/content/setup/kubernetes.md b/docs/content/setup/kubernetes.md
deleted file mode 100644
index 7ece0d20..00000000
--- a/docs/content/setup/kubernetes.md
+++ /dev/null
@@ -1,5 +0,0 @@
-# Kubernetes
-
-HedgeDoc currently does not support any deployment via Kubernetes.
-
-If you want to help us creating a helm chart, then feel free to contact us on [Matrix](https://chat.hedgedoc.org/) or [Discourse](https://community.hedgedoc.org/).
diff --git a/docs/content/theme/styles/hedgedoc-custom.css b/docs/content/theme/styles/hedgedoc-custom.css
index 54e18919..e3c52757 100644
--- a/docs/content/theme/styles/hedgedoc-custom.css
+++ b/docs/content/theme/styles/hedgedoc-custom.css
@@ -1,17 +1,26 @@
[data-md-color-primary=hedgedoc] {
- --md-primary-fg-color: #b51f08;
- --md-primary-fg-color--light: #b51f08;
- --md-primary-fg-color--dark: #b51f08;
- --md-primary-bg-color: hsla(0, 0%, 100%, 1);
- --md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7);
+ --md-primary-fg-color: #b51f08;
+ --md-primary-fg-color--light: #b51f08;
+ --md-primary-fg-color--dark: #b51f08;
+ --md-primary-bg-color: hsla(0, 0%, 100%, 1);
+ --md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7);
}
[data-md-color-accent=hedgedoc] {
- --md-accent-fg-color: #b51f08;
- --md-accent-fg-color--transparent: hsla(348, 100%, 55%, 0.1);
- --md-accent-bg-color: hsla(0, 0%, 100%, 1);
- --md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7);
+ --md-accent-fg-color: #b51f08;
+ --md-accent-fg-color--transparent: hsla(348, 100%, 55%, 0.1);
+ --md-accent-bg-color: hsla(0, 0%, 100%, 1);
+ --md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7);
}
+
.md-grid {
max-width: 1440px;
}
+
+.twitter {
+ color: #1DA1F2;
+}
+
+.mastodon {
+ color: #2b90d9;
+}
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index dcdd531a..f0dfb723 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -8,14 +8,19 @@ edit_uri: https://github.com/hedgedoc/hedgedoc/edit/master/docs/content/
nav:
- Home: index.md
- Installation:
- - 'Manual Installation': setup/manual-setup.md
- - 'Reverse Proxy': setup/reverse-proxy.md
- - Docker: setup/docker.md
- - Cloudron: setup/cloudron.md
- - Heroku: setup/heroku.md
- - LinuxServer: setup/docker-linuxserver.md
- - Yunohost: setup/yunohost.md
+ - 'Getting Started': setup/getting-started.md
+ - Official installation methods:
+ - 'Docker Image': setup/docker.md
+ - 'Manual Installation': setup/manual-setup.md
+ - Heroku: setup/heroku.md
+ - Community installation methods:
+ - 'LinuxServer Docker Image': setup/docker-linuxserver.md
+ - 'Helm Chart': setup/kubernetes-helm.md
+ - 'YunoHost App': setup/yunohost.md
+ - 'Cloudron App': setup/cloudron.md
+ - 'Arch Linux Package': setup/arch-linux.md
- Guides:
+ - 'Reverse Proxy': guides/reverse-proxy.md
- Authentication:
- LDAP: guides/auth/ldap-ad.md
- OAuth: guides/auth/oauth.md
@@ -47,6 +52,10 @@ markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences
- mdx_truly_sane_lists
+ - pymdownx.emoji:
+ emoji_index: !!python/name:materialx.emoji.twemoji
+ emoji_generator: !!python/name:materialx.emoji.to_svg
+ - attr_list
theme:
name: 'material'
language: en
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 043febc1..1f025c14 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,4 +1,4 @@
mkdocs==1.1.2
-mkdocs-material==6.2.3
-pymdown-extensions==8.1
+mkdocs-material==6.2.8
+pymdown-extensions==8.1.1
mdx_truly_sane_lists==1.2
diff --git a/package.json b/package.json
index 6b0f0da3..3ec5f17e 100644
--- a/package.json
+++ b/package.json
@@ -20,7 +20,7 @@
"@passport-next/passport-openid": "^1.0.0",
"Idle.Js": "git+https://github.com/shawnmclean/Idle.js",
"archiver": "^5.0.2",
- "async": "^2.1.4",
+ "async": "^3.0.0",
"aws-sdk": "^2.521.0",
"azure-storage": "^2.7.0",
"base64url": "^3.0.0",
@@ -186,7 +186,7 @@
"eslint-plugin-standard": "4.1.0",
"expose-loader": "0.7.5",
"file-loader": "4.3.0",
- "html-webpack-plugin": "4.5.0",
+ "html-webpack-plugin": "4.5.1",
"imports-loader": "0.8.0",
"jsonlint": "1.6.3",
"less": "3.13.1",
@@ -200,7 +200,7 @@
"script-loader": "0.7.2",
"string-loader": "0.0.1",
"url-loader": "2.3.0",
- "webpack": "4.44.2",
+ "webpack": "4.46.0",
"webpack-cli": "3.3.12",
"webpack-merge": "4.2.2"
},
diff --git a/public/js/slide.js b/public/js/slide.js
index e0e831ca..b8374cbb 100644
--- a/public/js/slide.js
+++ b/public/js/slide.js
@@ -72,56 +72,57 @@ const defaultOptions = {
// options from yaml meta
const meta = JSON.parse($('#meta').text())
+const metaSlideOptions = !!meta && !!meta.slideOptions ? meta.slideOptions : {}
var options = {
- autoPlayMedia: meta.slideOptions.autoPlayMedia,
- autoSlide: meta.slideOptions.autoSlide,
- autoSlideStoppable: meta.slideOptions.autoSlideStoppable,
- backgroundTransition: meta.slideOptions.backgroundTransition,
- center: meta.slideOptions.center,
- controls: meta.slideOptions.controls,
- controlsBackArrows: meta.slideOptions.controlsBackArrows,
- controlsLayout: meta.slideOptions.controlsLayout,
- controlsTutorial: meta.slideOptions.controlsTutorial,
- defaultTiming: meta.slideOptions.defaultTiming,
- display: meta.slideOptions.display,
- embedded: meta.slideOptions.embedded,
- fragmentInURL: meta.slideOptions.fragmentInURL,
- fragments: meta.slideOptions.fragments,
- hash: meta.slideOptions.hash,
- height: meta.slideOptions.height,
- help: meta.slideOptions.help,
- hideAddressBar: meta.slideOptions.hideAddressBar,
- hideCursorTime: meta.slideOptions.hideCursorTime,
- hideInactiveCursor: meta.slideOptions.hideInactiveCursor,
- history: meta.slideOptions.history,
- keyboard: meta.slideOptions.keyboard,
- loop: meta.slideOptions.loop,
- margin: meta.slideOptions.margin,
- maxScale: meta.slideOptions.maxScale,
- minScale: meta.slideOptions.minScale,
- minimumTimePerSlide: meta.slideOptions.minimumTimePerSlide,
- mobileViewDistance: meta.slideOptions.mobileViewDistance,
- mouseWheel: meta.slideOptions.mouseWheel,
- navigationMode: meta.slideOptions.navigationMode,
- overview: meta.slideOptions.overview,
- parallaxBackgroundHorizontal: meta.slideOptions.parallaxBackgroundHorizontal,
- parallaxBackgroundImage: meta.slideOptions.parallaxBackgroundImage,
- parallaxBackgroundSize: meta.slideOptions.parallaxBackgroundSize,
- parallaxBackgroundVertical: meta.slideOptions.parallaxBackgroundVertical,
- preloadIframes: meta.slideOptions.preloadIframes,
- previewLinks: meta.slideOptions.previewLinks,
- progress: meta.slideOptions.progress,
- rtl: meta.slideOptions.rtl,
- showNotes: meta.slideOptions.showNotes,
- shuffle: meta.slideOptions.shuffle,
- slideNumber: meta.slideOptions.slideNumber,
- theme: meta.slideOptions.theme,
- totalTime: meta.slideOptions.totalTime,
- touch: meta.slideOptions.touch,
- transition: meta.slideOptions.transition,
- transitionSpeed: meta.slideOptions.transitionSpeed,
- viewDistance: meta.slideOptions.viewDistance,
- width: meta.slideOptions.width
+ autoPlayMedia: metaSlideOptions.autoPlayMedia,
+ autoSlide: metaSlideOptions.autoSlide,
+ autoSlideStoppable: metaSlideOptions.autoSlideStoppable,
+ backgroundTransition: metaSlideOptions.backgroundTransition,
+ center: metaSlideOptions.center,
+ controls: metaSlideOptions.controls,
+ controlsBackArrows: metaSlideOptions.controlsBackArrows,
+ controlsLayout: metaSlideOptions.controlsLayout,
+ controlsTutorial: metaSlideOptions.controlsTutorial,
+ defaultTiming: metaSlideOptions.defaultTiming,
+ display: metaSlideOptions.display,
+ embedded: metaSlideOptions.embedded,
+ fragmentInURL: metaSlideOptions.fragmentInURL,
+ fragments: metaSlideOptions.fragments,
+ hash: metaSlideOptions.hash,
+ height: metaSlideOptions.height,
+ help: metaSlideOptions.help,
+ hideAddressBar: metaSlideOptions.hideAddressBar,
+ hideCursorTime: metaSlideOptions.hideCursorTime,
+ hideInactiveCursor: metaSlideOptions.hideInactiveCursor,
+ history: metaSlideOptions.history,
+ keyboard: metaSlideOptions.keyboard,
+ loop: metaSlideOptions.loop,
+ margin: metaSlideOptions.margin,
+ maxScale: metaSlideOptions.maxScale,
+ minScale: metaSlideOptions.minScale,
+ minimumTimePerSlide: metaSlideOptions.minimumTimePerSlide,
+ mobileViewDistance: metaSlideOptions.mobileViewDistance,
+ mouseWheel: metaSlideOptions.mouseWheel,
+ navigationMode: metaSlideOptions.navigationMode,
+ overview: metaSlideOptions.overview,
+ parallaxBackgroundHorizontal: metaSlideOptions.parallaxBackgroundHorizontal,
+ parallaxBackgroundImage: metaSlideOptions.parallaxBackgroundImage,
+ parallaxBackgroundSize: metaSlideOptions.parallaxBackgroundSize,
+ parallaxBackgroundVertical: metaSlideOptions.parallaxBackgroundVertical,
+ preloadIframes: metaSlideOptions.preloadIframes,
+ previewLinks: metaSlideOptions.previewLinks,
+ progress: metaSlideOptions.progress,
+ rtl: metaSlideOptions.rtl,
+ showNotes: metaSlideOptions.showNotes,
+ shuffle: metaSlideOptions.shuffle,
+ slideNumber: metaSlideOptions.slideNumber,
+ theme: metaSlideOptions.theme,
+ totalTime: metaSlideOptions.totalTime,
+ touch: metaSlideOptions.touch,
+ transition: metaSlideOptions.transition,
+ transitionSpeed: metaSlideOptions.transitionSpeed,
+ viewDistance: metaSlideOptions.viewDistance,
+ width: metaSlideOptions.width
} || {}
for (const key in options) {
diff --git a/yarn.lock b/yarn.lock
index 80246f63..45273dc0 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -818,7 +818,7 @@ async-limiter@~1.0.0:
resolved "https://registry.yarnpkg.com/async-limiter/-/async-limiter-1.0.1.tgz#dd379e94f0db8310b08291f9d64c3209766617fd"
integrity sha512-csOlWGAcRFJaI6m+F2WKdnMKr4HhdhFVBk0H/QbJFMCr+uO2kwohwXQPxw/9OCxp05r5ghVBFSyioixx3gfkNQ==
-async@>=0.6.0, async@^3.1.0, async@^3.2.0:
+async@>=0.6.0, async@^3.0.0, async@^3.1.0, async@^3.2.0:
version "3.2.0"
resolved "https://registry.yarnpkg.com/async/-/async-3.2.0.tgz#b3a2685c5ebb641d3de02d161002c60fc9f85720"
integrity sha512-TR2mEZFVOj2pLStYxLht7TyfuRzaydfpxr3k9RpHIzMgw7A64dzsdqCxH1WJyQdoe8T10nDXd9wnEigmiuHIZw==
@@ -828,13 +828,6 @@ async@^1.4.0, async@^1.5.2:
resolved "https://registry.yarnpkg.com/async/-/async-1.5.2.tgz#ec6a61ae56480c0c3cb241c95618e20892f9672a"
integrity sha1-7GphrlZIDAw8skHJVhjiCJL5Zyo=
-async@^2.1.4:
- version "2.6.3"
- resolved "https://registry.yarnpkg.com/async/-/async-2.6.3.tgz#d72625e2344a3656e3a3ad4fa749fa83299d82ff"
- integrity sha512-zflvls11DCy+dQWzTW2dzuilv8Z5X/pjfmZOWba6TNIVDm+2UDaJmXSOXlasHKfNBs8oo3M0aT50fDEWfKZjXg==
- dependencies:
- lodash "^4.17.14"
-
asynckit@^0.4.0:
version "0.4.0"
resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79"
@@ -3607,7 +3600,7 @@ engine.io@~3.5.0:
engine.io-parser "~2.2.0"
ws "~7.4.2"
-enhanced-resolve@^4.1.1, enhanced-resolve@^4.3.0:
+enhanced-resolve@^4.1.1, enhanced-resolve@^4.5.0:
version "4.5.0"
resolved "https://registry.yarnpkg.com/enhanced-resolve/-/enhanced-resolve-4.5.0.tgz#2f3cfd84dbe3b487f18f2db2ef1e064a571ca5ec"
integrity sha512-Nv9m36S/vxpsI+Hc4/ZGRs0n9mXqSWGGq49zxb/cJfPAQMbUtttJAlNPS4AQzaBdw/pKskw5bMbekT/Y7W/Wlg==
@@ -5039,17 +5032,17 @@ html-minifier@^4.0.0:
relateurl "^0.2.7"
uglify-js "^3.5.1"
-html-webpack-plugin@4.5.0:
- version "4.5.0"
- resolved "https://registry.yarnpkg.com/html-webpack-plugin/-/html-webpack-plugin-4.5.0.tgz#625097650886b97ea5dae331c320e3238f6c121c"
- integrity sha512-MouoXEYSjTzCrjIxWwg8gxL5fE2X2WZJLmBYXlaJhQUH5K/b5OrqmV7T4dB7iu0xkmJ6JlUuV6fFVtnqbPopZw==
+html-webpack-plugin@4.5.1:
+ version "4.5.1"
+ resolved "https://registry.yarnpkg.com/html-webpack-plugin/-/html-webpack-plugin-4.5.1.tgz#40aaf1b5cb78f2f23a83333999625c20929cda65"
+ integrity sha512-yzK7RQZwv9xB+pcdHNTjcqbaaDZ+5L0zJHXfi89iWIZmb/FtzxhLk0635rmJihcQbs3ZUF27Xp4oWGx6EK56zg==
dependencies:
"@types/html-minifier-terser" "^5.0.0"
"@types/tapable" "^1.0.5"
"@types/webpack" "^4.41.8"
html-minifier-terser "^5.0.1"
loader-utils "^1.2.3"
- lodash "^4.17.15"
+ lodash "^4.17.20"
pretty-error "^2.1.1"
tapable "^1.1.3"
util.promisify "1.0.0"
@@ -11434,10 +11427,10 @@ webpack-sources@^1.1.0, webpack-sources@^1.4.0, webpack-sources@^1.4.1, webpack-
source-list-map "^2.0.0"
source-map "~0.6.1"
-webpack@4.44.2:
- version "4.44.2"
- resolved "https://registry.yarnpkg.com/webpack/-/webpack-4.44.2.tgz#6bfe2b0af055c8b2d1e90ed2cd9363f841266b72"
- integrity sha512-6KJVGlCxYdISyurpQ0IPTklv+DULv05rs2hseIXer6D7KrUicRDLFb4IUM1S6LUAKypPM/nSiVSuv8jHu1m3/Q==
+webpack@4.46.0:
+ version "4.46.0"
+ resolved "https://registry.yarnpkg.com/webpack/-/webpack-4.46.0.tgz#bf9b4404ea20a073605e0a011d188d77cb6ad542"
+ integrity sha512-6jJuJjg8znb/xRItk7bkT0+Q7AHCYjjFnvKIWQPkNIOyRqoCGvkOs0ipeQzrqz4l5FtN5ZI/ukEHroeX/o1/5Q==
dependencies:
"@webassemblyjs/ast" "1.9.0"
"@webassemblyjs/helper-module-context" "1.9.0"
@@ -11447,7 +11440,7 @@ webpack@4.44.2:
ajv "^6.10.2"
ajv-keywords "^3.4.1"
chrome-trace-event "^1.0.2"
- enhanced-resolve "^4.3.0"
+ enhanced-resolve "^4.5.0"
eslint-scope "^4.0.3"
json-parse-better-errors "^1.0.2"
loader-runner "^2.4.0"
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-26 18:22:12 +0000