Note
This new unified FreeCAD website is in a WIP migration phase. The current official website repository is still FreeCAD-Homepage for now.
Contributions • Structure • CMS • Theme • Tips • License
Welcome to the source of the FreeCAD website!
The content, assets, theme code and style are all gathered in this repository. The site is statically generated thanks to Hugo, a fast and flexible static site generator written in Golang.
For other parts of FreeCAD web ecosystem, head to:
- FreeCAD software source
- FreeCAD Wiki
- FreeCAD Developers Handbook and its source
- FreeCAD Forum
- FreeCAD Project Association and its source
Contributions are always welcome!
The FreeCAD website source is freely accessible and open just like FreeCAD.
When contributing to the website, keep in mind that it acts as the public face of the FreeCAD organization and community. Substantial changes must be discussed beforehand via its usual communication channels (e.g. GitHub, Matrix chat, Forum). FreeCAD's code of conduct must be observed at any time.
Contributions of all kinds are welcome: content, translations, bug fixes, theme improvements, testing, documentation, bug reports, and more... Depending on the scope, some basic know-how of Git, Markdown, HTML, CSS, Javascript, YAML/JSON and Hugo template syntax is recommended. Create appropriate feature issues to discuss substantial changes before submitting Pull Requests. Also use the appropriate Pull Request template and make sure reviewers are assigned.
Please read the Website introduction and Guidelines.
For bug report, use the provided bug issues template.
Thank you!
The website uses a simple folder-based structure. The Homepage links to main sections (e.g. Features, Download, News) which may contain sub-sections (e.g. Release notes, User documentation). All content is stored in files and the structure is kept to a minimum number of levels for ease.
The website is multilingual, with English being the default language. Available translated content in any enabled language is accessible using the language dropdown in the header.
A light and dark chroma version of the Theme is available on the sun/moon icon on the top header.
Hugo, the static site generator used, takes the plain-text content (typically Markdown) and data files (typically CSV, JSON, XML and YAML), marries them to an appropriate set of templates and produces a complete set of HTML pages (with CSS and Javascript) that can be served by any generic standalone web server.
To understand how Hugo works, read its Official documentation.
Note
Currently the CMS is WIP and its structure and content may change in the near future.
A server-less Content Management System is available to manage content easily. It is based on the Sveltia CMS project. A single JavaScript interacts with the Git repository of the website. It can be used locally on supported web browsers (currently only Chromium-based) or via GitHub login. Pages, translations and resources such as illustrations can be added, edited or deleted directly from the content panel of available collections.
Note
The Trigo Theme is WIP and its structure and methods may change in the near future.
The custom-made Trigo Theme is used. It is included directly in the themes/trigo directory. Read its own documentation to find out more.
This repository is licensed under the GNU Lesser General Public License Version 2.1.
Content of the website is licensed under Creative Commons Attribution ShareAlike 4.0 International. By default, it is copyrighted by and attributed to "FreeCAD". If they wish so, authors can specify the respective attribution for the content they produce. For Markdown files, the attribution is specified in the author field of the Front Matter.
By submitting Pull Requests to this repository, make sure who is the author of the content. Make sure rights to share under the CC-BY-SA 4.0 license and original author mention are respected. Also note that sharing images with people is subject to obtaining appropriate consent.
The trademark of FreeCAD branded resources (e.g. FreeCAD logo) is registered and owned by the FreeCAD Project Association.
The Trigo Theme is licensed under the MIT License.