google
/
docsy-example
mirror of https://github.com/google/docsy-example.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
An example documentation site using the Docsy Hugo theme
418 Commits 1 Branch 11 Tags 492 MiB
HTML 92.7%
Dockerfile 4.5%
SCSS 2.8%
Go to file
Uriel Ofir 2686606dfc Update Hebrew blog post on content recommendations to include a new section on Rich Hickey's talks, enhancing the resource list for readers. 2025-06-21 15:18:48 +03:00
.github
…
.vscode Remove unused content and images from the project. Add Hebrew language support with new content for the community and documentation sections. Update package metadata to reflect new author information. 2025-05-30 06:30:57 +03:00
assets Remove unused SCSS variables file and add spacing to the Hebrew 404 page for improved layout. 2025-06-07 20:15:42 +03:00
content/he Update Hebrew blog post on content recommendations to include a new section on Rich Hickey's talks, enhancing the resource list for readers. 2025-06-21 15:18:48 +03:00
i18n Update hugo.yaml with GitHub repository links and enable feedback feature; add Hebrew translations for UI strings and error messages 2025-06-01 13:12:31 +03:00
layouts/shortcodes add giscus comments 2025-06-20 11:58:04 +03:00
.cspell.yml `hugo.yaml` from toml config, preserving comments (#299) 2024-05-16 20:34:06 -04:00
.gitignore
…
.nvmrc
…
CONTRIBUTING.md
…
Dockerfile Update docker files 2023-11-29 18:16:43 +01:00
LICENSE
…
README.md Update README.md to reflect the Maakaf community's mission and local development instructions; remove outdated Docsy example content and add community links. 2025-06-01 16:23:18 +03:00
config.yaml
…
docker-compose.yaml Update docker files 2023-11-29 18:16:43 +01:00
docsy.work Hugo workspace supporting use of local Docsy (#194) 2023-11-10 04:57:52 -05:00
docsy.work.sum Hugo workspace supporting use of local Docsy (#194) 2023-11-10 04:57:52 -05:00
go.mod Upgrade Docsy to version 0.12.0 (#368) 2025-05-27 16:23:28 -04:00
go.sum Upgrade Docsy to version 0.12.0 (#368) 2025-05-27 16:23:28 -04:00
hugo-disabled.toml Upgrade Docsy to version 0.12.0 (#368) 2025-05-27 16:23:28 -04:00
hugo.yaml Add Google Analytics configuration to hugo.yaml 2025-06-15 17:55:32 +03:00
netlify.toml Enhance 404 handling by adding a custom Hebrew 404 page, updating Netlify redirects, and configuring security headers in netlify.toml. Modify hugo.yaml to disable aliases for 404s. 2025-06-06 14:50:00 +03:00
package.json Bump hugo-extended from 0.147.6 to 0.147.8 2025-06-12 20:20:27 +00:00

README.md

מעקף - Maakaf

מעקף היא קהילת קוד פתוח ישראלית המקדמת פרויקטים של תוכנה חופשית. Maakaf is an Israeli open source community promoting free software projects.

About This Website

This is the official website for the Maakaf community. It's built using Hugo with the Docsy theme, providing a comprehensive platform for our community's documentation, blog posts, and project information.

Local Development

To run this website locally, you'll need:

  • Hugo Extended (version 0.146.0 or higher)
  • Go (for Hugo modules)
  • Node.js and npm (for SCSS processing)

Setup and Run

  1. Clone the repository:
git clone https://github.com/Maakaf/maakaf_home.git
cd maakaf_home
  1. Install dependencies:
npm install
  1. Run the development server:
hugo server

The site will be available at http://localhost:1313

Community Links

Contributing

We welcome contributions from the community! Whether it's:

  • Adding new documentation
  • Fixing typos or improving existing content
  • Translating content
  • Suggesting improvements

Please feel free to open an issue or submit a pull request.

License

This project is built on top of Docsy, which is licensed under the Apache License 2.0. Our content and modifications are available under the same terms.