Standard in-repo documentation is often strictly technical. Marketing features like promotion, testimonials, or interactive examples are frequently limited or altogether omitted to keep the codebase clean.
While project or company websites are excellent presentation hubs, they are prone to being restructured, redesigned, or re-purposed, leading to the partial or entire loss of historical project context.
A dedicated static website for each repository bridges these gaps:
- Persistent Availability: It lives as long as the repository exists.
- Version-Synchronized: The documentation evolves and is versioned alongside the code.
- Global Reach: Supports full translation and native language selection.
- Zero Overhead: High-performance hosting with no additional infrastructure costs.
- All related links can be included, without need to think about impacts concerning infrastructure and how to keep information bundled.
- The website resides in the repository itself and doesn't need any additional platform.
With according workflows parts of your repository can be deployed to different targets, to keep distributions focused and clean.
This website for example is part of a larger repository but separately pushed on github, to provide just the website itself.
It is of course possible to create and deploy static websites stand-alone without any direct context.
This is often used for profile-pages of developers who don't need a dynamic website to promote their services.
Long words short: ACTION!
Head over to your repository and get the setup-script:
curl -sSL https://gitlab.com/vvdb/static-repo-page-kickstart/-/raw/main/setup.sh?ref_type=heads | bash
This script will launch the prepared installer script, which will do essentially the following things for you:
- Asking for fundamental requirements like repository name and more.
- Download and pre-configure Docusaurus as framework for static websites.
- Provide a workflow for github- or gitlab-actions depending on your choice.
- Provide information how to succeed so far and how to proceed.
What is Docusaurus?
Docusaurus is a framework to render static websites based on mark-down documents, directory structure and React.js.
The framework itself won't be deployed to the static website, it's rather building the whole website based on the provided content, features and configuration.
Have a look at the Docusaurus Showcase to see the huge amount of projects which use Docusaurus.
Easy to Use
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
Focus on What Matters
Docusaurus lets you focus on your docs, and we'll do the chores. Go ahead and move your docs into the docs directory.
Powered by React
Extend or customize your website layout by reusing React. Docusaurus can be extended while reusing the same header and footer.