DocuGen repo: Setup initial Docusaurus website

[basplijnaer]

To create a working base website we want to have something running to build upon.

• [x] Create a simple hello world Docusaurus website
• [x] Deploy to github pages

[stefjoosten]

I would expect that GitHub pages is the way to do this. Please disagree if you think otherwise.

[hanjoosten]

Github pages is indeed the way to go to serve the 1-page-website. To generate that site from whatever content we have, we need source depending on the tool we use to generate it. If we go for docusaurus, we need to generate a website as explained here. The result of such website should be stored in a new repo at AmpersandTarski. If that is done, we have to see how the docs directories of Ampersand and prototype fit in that repo, so together they can be used to let docusaurus generate the 1-page-website.

[hanjoosten]

BTW, I saw that we are not the only project to move away from Gitbook. Redux did this. You can read about there whereabouts over here. They have a nice thread about their motivation and what they did. Could be insirational for the team.

[Michiel-s]

As example, here's a Dockerfile we used to create a static Docusaurus website that can be served by any webserver. In the setup below we use NGINX image as webserver, but that will be Github pages then.

The npm run build cmd kicks of the Docusaurus build script.

FROM node:lts as build

WORKDIR /app

COPY package.json package-lock.json /app/

RUN npm install

COPY ./ /app/

RUN npm run build

FROM nginx:stable-alpine

COPY --from=build /app/build /usr/share/nginx/html
COPY ./nginx-conf /etc/nginx/conf.d

[basplijnaer]

The Docusaurus website is available at: https://ampersandtarski.github.io/DocuGen/