A concise, modern website prototype for DocumentDB, built with Next.js and Tailwind CSS. The site features a list of community blog posts and core documentation. Content is managed via YAML and Markdown files for easy editing and extensibility.
-
Open
blogs/content.ymlin the repository. -
Add your blog post as a new entry, following the format of existing posts (title, author, date, summary, etc).
- The YAML file is validated against its schema for consistency and editor support.
- Submit a pull request for review.
-
Navigate to the appropriate folder under
articles/(e.g.,articles/quickstart/,articles/postgresql/). -
Add your article as a Markdown file (
.md).
- Update the corresponding
navigation.ymlto include your new article if needed. - Ensure your content follows the structure and style of existing articles.
- Submit a pull request for review.
-
Open the relevant file in the
reference/directory (e.g.,reference/content.yml, or a command/operator YAML file). -
Add or update entries according to the schema and format used in existing files.
- Reference content is organized by command, operator, and type. Follow the folder structure for new additions.
- Use the schemas in the
schema/directory for guidance and validation.
- Submit a pull request for review.
You can develop and preview the site in a fully configured environment using GitHub Codespaces:
-
Launch a devcontainer with all dependencies pre-installed.
-
The environment includes Node.js, Next.js, and Tailwind CSS setup for instant development and preview.
-
Install packages with
npm install -
Use
npm run devto start the local server and preview changes. -
The environment also includes the required Visual Studio Code extensions to edit the Markdown and YAML files with full completion support.
[!TIP] You can use these same steps if you opt to develop on your local machine. Ensure that you are using at least the latest LTS version of Node.js