Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .vscode/cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"words": [
"afdocs",
"anchorize",
"autoloader",
"basenames",
"baseof",
"chalin",
Expand Down Expand Up @@ -39,11 +40,13 @@
"htmltest",
"hugo",
"isset",
"katex",
"lastmod",
"llms",
"lockfiles",
"magick",
"markdownify",
"markmap",
"mentees",
"navbars",
"nguyen",
Expand Down
10 changes: 0 additions & 10 deletions Dockerfile

This file was deleted.

14 changes: 0 additions & 14 deletions docker-compose.yaml

This file was deleted.

1 change: 1 addition & 0 deletions docsy.dev/.lycheecache
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,7 @@ https://github.com/google/docsy/pull/2722,200,1787153684
https://github.com/google/docsy/pull/2724,200,1787076569
https://github.com/google/docsy/pull/2726,200,1787137876
https://github.com/google/docsy/pull/2731,200,1787331617
https://github.com/google/docsy/pull/2748,200,1787848215
https://github.com/google/docsy/pull/941,200,1782498225
https://github.com/google/docsy/pulls,200,1782563369
https://github.com/google/docsy/releases,200,1782563368
Expand Down
43 changes: 0 additions & 43 deletions docsy.dev/content/en/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,49 +131,6 @@ work:
1. Continue with the usual GitHub workflow to edit files, commit them, push the
changes up to your fork, and create a pull request.

#### Preview your changes using a Docker container

Docsy comes with `Dockerfile` and `docker-compose` files to run the server
locally with Docker, without installing any additional dependencies.

- Using [Docker]:
1. Build the Docker container:

```bash
docker build -t docsy/user-guide .
```

1. Run the container, mounting the repository as a shared volume:

```bash
docker run -it --user=$(id -u):$(id -g) -p 1313:1313 \
-v $(pwd):/app/docsy -v /app/docsy/docsy.dev/node_modules \
docsy/user-guide
```

- Using [Docker Compose][docker-compose]:
1. Build the container:

```bash
docker-compose build
```

1. Run the container:

```bash
DOCSY_USER=$(id -u):$(id -g) docker-compose up
```

Open <http://localhost:1313> in your web browser to load the docsy user guide.
In most cases, docsy will automatically reload the site to reflect any changes
to the documentation or the code. Changes to some parts of the docsy code may
require manually reloading the page or re-starting the container.

Press **Ctrl + C** to stop the container.

[docker]: https://docs.docker.com/get-docker/
[docker-compose]: https://docs.docker.com/compose/install/

### User guide formatting

We use [Prettier](https://prettier.io) to format the markdown source of the User
Expand Down
5 changes: 2 additions & 3 deletions docsy.dev/content/en/docs/get-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >-
Learn how to get started with Docsy, including the available options for
installing and using the Docsy theme.
date: 2018-07-30
aliases: [getting-started]
aliases: [getting-started, get-started/quickstart-docker]
weight: 2
---

Expand All @@ -16,8 +16,7 @@ our example site, though we also provide instructions for adding the Docsy theme
manually to new or existing sites.

If you want to build and test your site locally you also need to be able to run
Hugo itself, either by installing it and any other required dependencies, or by
using our provided Docker container.
Hugo itself, by installing it and any other required dependencies.

This page describes Docsy's installation options and helps you choose the
appropriate setup guide to get started.
Expand Down
80 changes: 0 additions & 80 deletions docsy.dev/content/en/docs/get-started/quickstart-docker.md

This file was deleted.

5 changes: 4 additions & 1 deletion docsy.dev/content/en/project/about/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Changelog
description: Docsy repository changelog
aliases: [../changelog]
# prettier-ignore
cSpell:ignore: deining FOUC gitmodules gtag katex lookandfeel mhchem navs notoc tabpane onedark shurup
cSpell:ignore: deining FOUC gitmodules gtag lookandfeel mhchem navs notoc tabpane onedark shurup
---

We document **breaking changes** and release **highlights** in this page, with
Expand Down Expand Up @@ -179,6 +179,8 @@ full list of changes, see the [0.17.0][] release page or the [git history since
([#2614][]).
- Silenced Sass deprecation warnings in site builds, project style files
included; see the [release report][0.17.0-blog-dart-sass] ([#2731][]).
- Dropped broken `Dockerfile` and `docker-compose.yaml` files and retired Docker
quickstart page ([#2748][]).

**For maintainers**:

Expand Down Expand Up @@ -214,6 +216,7 @@ full list of changes, see the [0.17.0][] release page or the [git history since
[#2724]: https://github.com/google/docsy/pull/2724
[#2726]: https://github.com/google/docsy/pull/2726
[#2731]: https://github.com/google/docsy/pull/2731
[#2748]: https://github.com/google/docsy/pull/2748
[0.17.0 release report]: /blog/2026/0.17.0/
[0.17.0-blog-dart-sass]: /blog/2026/0.17.0/#dart-sass
[0.17.0-blog-install]: /blog/2026/0.17.0/#install-command
Expand Down
4 changes: 1 addition & 3 deletions docsy.dev/tests/md-output/goldens/docs/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ our example site, though we also provide instructions for adding the Docsy theme
manually to new or existing sites.

If you want to build and test your site locally you also need to be able to run
Hugo itself, either by installing it and any other required dependencies, or by
using our provided Docker container.
Hugo itself, by installing it and any other required dependencies.

This page describes Docsy's installation options and helps you choose the
appropriate setup guide to get started.
Expand Down Expand Up @@ -71,6 +70,5 @@ Section pages:

- [Use Docsy as a Hugo Module](/docs/get-started/docsy-as-module/): Learn how to get started with Docsy by using the theme as a Hugo Module.
- [Other setup options](/docs/get-started/other-options/): Install Docsy as a Git submodule, a clone, or the @docsy/theme npm package, for sites not using Hugo modules.
- [Deploy Docsy inside a Docker container](/docs/get-started/quickstart-docker/): Instructions on how to set up and run a local Docsy site with Docker.
- [Basic site configuration](/docs/get-started/basic-configuration/): Basic configuration for new Docsy sites.
- [Troubleshooting and known issues](/docs/get-started/troubleshooting/): Troubleshooting and known issues when installing and using Docsy.
Loading