Docusaurus - Documentation/Simple Websites
-
-
Any update on this? This looks like a decent option for technical documentation.
Btw, https://www.mkdocs.org also is ok.
-
@pani-avula You can already use mkdocs with the surfer app. We use mkdocs for https://docs.cloudron.io (https://git.cloudron.io/cloudron/docs)
-
-
@pani-avula You can already use mkdocs with the surfer app. We use mkdocs for https://docs.cloudron.io (https://git.cloudron.io/cloudron/docs)
@girish How exactly do you serve this via surfer? I can only see the pip installation method.
-
@girish How exactly do you serve this via surfer? I can only see the pip installation method.
@andreasdueren said in Docusaurus - Documentation/Simple Websites:
I can only see the pip install
I don't really know because I haven't tried it, but presumably you do that on your local machine, then use it to generate some static files, then upload those static files to Surfer.
-
@girish How exactly do you serve this via surfer? I can only see the pip installation method.
@andreasdueren You install docusaurus locally on your computer, then generate the site (specific instructions are in their repo I believe). The site generates into static html pages into a project folder (given a name via the config you make while setting up the docusaurus website) and you can take that and push it to surfer (which can host static html files.)
--
https://urgero.org
~ Professional Nerd. Freelance Programmer. ~ -
@andreasdueren You install docusaurus locally on your computer, then generate the site (specific instructions are in their repo I believe). The site generates into static html pages into a project folder (given a name via the config you make while setting up the docusaurus website) and you can take that and push it to surfer (which can host static html files.)
-
@murgero Sorry I meant mkdocs
@andreasdueren Not sure if this is what you are asking but our docs are generated from mkdocs - https://git.cloudron.io/cloudron/docs . We have a CI file which builds and uploads to a surfer - https://git.cloudron.io/cloudron/docs/-/blob/master/.gitlab-ci.yml
-
@andreasdueren Not sure if this is what you are asking but our docs are generated from mkdocs - https://git.cloudron.io/cloudron/docs . We have a CI file which builds and uploads to a surfer - https://git.cloudron.io/cloudron/docs/-/blob/master/.gitlab-ci.yml
-
@girish Ah I see, I was hoping there was a simple way to just build it as a static website without docker.
@andreasdueren said in Docusaurus - Documentation/Simple Websites:
@girish Ah I see, I was hoping there was a simple way to just build it as a static website without docker.
I'm pretty sure there is.
I suggest just having a read of the docs, perhaps starting with Getting Started
https://www.mkdocs.org/getting-started/
(these posts about mkdocs don't really belong in this thread though)
-
Substack is becoming popular as a platform for writing, but it is centralized. Docusaurus might work well as a decentralized way of publishing blogs. I hope we can support deployment on Cloudron.
@LoudLemur said in Docusaurus - Documentation/Simple Websites:
Substack is becoming popular as a platform for writing, but it is centralized. Docusaurus might work well as a decentralized way of publishing blogs. I hope we can support deployment on Cloudron.
The more apps the bettter, but we've already got Ghost which imho is the closest thing to an open source substack
-
I'm also super interested into this
I browsed some websites using Docusaurus and I was immediately tempted to give it a try -
Docusaurus 3.0 is now available: https://docusaurus.io/blog/releases/3.0
-
L LoudLemur referenced this topic on
-
Docusaurus 3.4 is now available, with better support for tags, offline browsing and local storage:
