Main project site https://selfprivacy.org
 
 
 
 
Go to file
nevfy bd3195125e
continuous-integration/drone/push Build is passing Details
fix(ru): typos
2024-06-16 14:26:37 +03:00
.idea feat: Switch to docsy 2023-01-11 19:53:46 +03:00
_vendor fix: text alignment 2024-06-09 22:24:25 +03:00
assets fix: text alignment 2024-06-09 22:24:25 +03:00
content fix(ru): typos 2024-06-16 14:26:37 +03:00
i18n fix: add ios link 2024-01-28 23:14:43 +04:00
layouts fix: docs article lead 2024-06-07 05:17:15 +03:00
static Reapply "Merge branch 'master' into set-img-size" 2024-05-01 15:27:11 +03:00
.drone.yml ci: Add installation of postcss-cli 2023-01-24 19:31:24 +03:00
.gitignore feat: Switch to docsy 2023-01-11 19:53:46 +03:00
.nvmrc feat: Switch to docsy 2023-01-11 19:53:46 +03:00
Dockerfile feat: Switch to docsy 2023-01-11 19:53:46 +03:00
LICENSE feat: Switch to docsy 2023-01-11 19:53:46 +03:00
README.md feat: Switch to docsy 2023-01-11 19:53:46 +03:00
config.toml fix: privacy policy 2024-04-29 17:20:22 +03:00
docker-compose.yaml feat: Switch to docsy 2023-01-11 19:53:46 +03:00
go.mod feat: upgrade theme 2024-04-22 21:13:55 +03:00
go.sum feat: upgrade theme 2024-04-22 21:13:55 +03:00
netlify.toml feat: Switch to docsy 2023-01-11 19:53:46 +03:00
package.json Update layout (#102) 2024-04-18 21:41:36 +03:00

README.md

Docsy Example

Docsy is a Hugo theme module for technical documentation sites, providing easy site navigation, structure, and more. This Docsy Example Project uses the Docsy theme component as a hugo module and provides a skeleton documentation structure for you to use. You can clone/copy this project and edit it with your own content, or use it as an example.

In this project, the Docsy theme component is pulled in as a Hugo module, together with other module dependencies:

$ hugo mod graph
hugo: collected modules in 566 ms
hugo: collected modules in 578 ms
github.com/google/docsy-example github.com/google/docsy@v0.5.1-0.20221017155306-99eacb09ffb0
github.com/google/docsy-example github.com/google/docsy/dependencies@v0.5.1-0.20221014161617-be5da07ecff1
github.com/google/docsy/dependencies@v0.5.1-0.20221014161617-be5da07ecff1 github.com/twbs/bootstrap@v4.6.2+incompatible
github.com/google/docsy/dependencies@v0.5.1-0.20221014161617-be5da07ecff1 github.com/FortAwesome/Font-Awesome@v0.0.0-20220831210243-d3a7818c253f

You can find detailed theme instructions in the Docsy user guide.

This Docsy Example Project is hosted on Netlify at example.docsy.dev. You can view deploy logs from the deploy section of the project's Netlify dashboard, or this alternate dashboard.

This is not an officially supported Google product. This project is currently maintained.

Using the Docsy Example Project as a template

A simple way to get started is to use this project as a template, which gives you a site project that is set up and ready to use. To do this:

  1. Click Use this template.

  2. Select a name for your new project and click Create repository from template.

  3. Make your own local working copy of your new repo using git clone, replacing https://github.com/me/example.git with your repos web URL:

git clone --depth 1 https://github.com/me/example.git

You can now edit your own versions of the sites source files.

If you want to do SCSS edits and want to publish these, you need to install PostCSS

npm install

Running the website locally

Building and running the site locally requires a recent extended version of Hugo. You can find out more about how to install Hugo for your environment in our Getting started guide.

Once you've made your working copy of the site repo, from the repo root folder, run:

hugo server

Running a container locally

You can run docsy-example inside a Docker container, the container runs with a volume bound to the docsy-example folder. This approach doesn't require you to install any dependencies other than Docker Desktop on Windows and Mac, and Docker Compose on Linux.

  1. Build the docker image

    docker-compose build
    
  2. Run the built image

    docker-compose up
    

    NOTE: You can run both commands at once with docker-compose up --build.

  3. Verify that the service is working.

    Open your web browser and type http://localhost:1313 in your navigation bar, This opens a local instance of the docsy-example homepage. You can now make changes to the docsy example and those changes will immediately show up in your browser after you save.

Cleanup

To stop Docker Compose, on your terminal window, press Ctrl + C.

To remove the produced images run:

docker-compose rm

For more information see the Docker Compose documentation.

Troubleshooting

As you run the website locally, you may run into the following error:

➜ hugo server

INFO 2021/01/21 21:07:55 Using config file: 
Building sites … INFO 2021/01/21 21:07:55 syncing static files to /
Built in 288 ms
Error: Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): resource "scss/scss/main.scss_9fadf33d895a46083cdd64396b57ef68" not found in file cache

This error occurs if you have not installed the extended version of Hugo. See this section of the user guide for instructions on how to install Hugo.

Or you may encounter the following error:

➜ hugo server

Error: failed to download modules: binary with name "go" not found

This error occurs if you have not installed the go programming language on your system. See this section of the user guide for instructions on how to install go.