An example documentation site using the Docsy Hugo theme
Go to file
Uriel Ofir ca341b4f65 Format relevant links in Generalsgame blog entry for improved readability 2025-06-01 17:56:42 +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 Add new images for the 'How to Start' guide and update Hebrew documentation 2025-05-30 07:44:01 +03:00
content/he Format relevant links in Generalsgame blog entry for improved readability 2025-06-01 17:56:42 +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 Update Hebrew documentation for mentors project and recommended projects; fix links and improve 404 page text 2025-06-01 07:53:03 +03:00
.cspell.yml
.gitignore
.nvmrc
CONTRIBUTING.md
Dockerfile
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
docsy.work
docsy.work.sum
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 Update hugo.yaml to change baseURL to root and update title to Hebrew translation for "מעקף" 2025-06-01 16:49:05 +03:00
netlify.toml
package.json 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

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

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.