https://github.com/sasuw/camilla
Cross-platform CLI tool for effortless sitemap generation
https://github.com/sasuw/camilla
cross-platform linux macos sitemap-generator sitemap-xml standalone-applications windows
Last synced: 12 months ago
JSON representation
Cross-platform CLI tool for effortless sitemap generation
- Host: GitHub
- URL: https://github.com/sasuw/camilla
- Owner: sasuw
- License: mit
- Created: 2020-09-14T11:40:22.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-03T05:29:17.000Z (about 1 year ago)
- Last Synced: 2025-04-03T06:29:13.732Z (about 1 year ago)
- Topics: cross-platform, linux, macos, sitemap-generator, sitemap-xml, standalone-applications, windows
- Language: Dart
- Homepage:
- Size: 23.4 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# About camilla
camilla is a standalone program for creating a [sitemap.xml](https://www.sitemaps.org/) file for static, internationalized websites. It runs as a single executable program on your Linux, Mac or Windows.
## Why?
There are many sitemap generators, but most of them are online or require specific dependencies (node, npm, Python). To fulfil my usage requirements I decided to create my own.
# Getting started as user
## Downloads
You can download the latest release from here: [https://github.com/sasuw/camilla/releases](https://github.com/sasuw/camilla/releases)
## Installing
Unpack the tar.gz or zip file and execute camilla from your terminal or command line window. For a more permanent installation, copy camilla e.g. to /usr/local/bin (Linux/MacOS) or to C:\Windows\system32 (Windows).
## Usage and functionality
Run camilla from the root directory of your static website. Camilla traverses through all directories, looking for files with type .html and creates a sitemap.xml file in the root directory of your website. You have to specify at least the
--baseUrl
option (or -b for short), e.g.
camilla -b 'https://example.com'
because all sitemap URLs have to be absolute. If you have an internationalized website, where every directory under the base url is a language directory, containing an identical file structure, you can run camilla with the
-- baseDirContainsLanguageDirs
option (or -l for short). This creates alternate language references in the sitemap file (see [Tell Google about localized versions of your page](https://support.google.com/webmasters/answer/189077?hl=en)).
### Example of sitemap.xml produced by camilla
https://example.com/de/index.html
2020-09-13
https://example.com/index.html
2020-09-13
https://example.com/en/index.html
2020-09-13
https://example.com/fi/index.html
2020-09-13
### Example of sitemap.xml produced by camilla when running with --baseDirContainsLanguageDirs option
https://example.com/de/index.html
2020-09-13
https://example.com/index.html
2020-09-13
https://example.com/en/index.html
2020-09-13
https://example.com/fi/index.html
2020-09-13
### Trying it out
To try `camilla` out you can create a test site structure by executing the Bash script `bin/scripts/create_test_site.sh` and executing `camilla` in that directory.
# Getting started as developer
## Prerequisites
Dart is installed. See [https://dart.dev/get-dart](https://dart.dev/get-dart)
## Project structure
Standard dart project structure created with [pub](https://dart.dev/tools/pub/cmd), see [https://dart.dev/tools/pub/package-layout](https://dart.dev/tools/pub/package-layout)
The main executable, camilla.dart is located in the bin directory. The internal libraries used by camilla are in the lib directory.
The tests are in the test directory and the test data is in the test/data directory.
## Create executable
dart pub get
dart compile exe bin/camilla.dart -o bin/camilla
## Running the code
When you are in the project root directory, you can execute
dart bin/camilla.dart
to run the program. For debugging, you can use e.g. [Visual Studio Code](https://code.visualstudio.com/).
# Miscellaneous
## Contributing
You can contribute to this project in many ways:
* submitting an issue (bug or enhancement proposal)
* testing
* contributing code
If you want to contribute code, please open an issue or contact me beforehand to ensure that your work in line with the project goals.
When you decide to commit some code:
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## Built With
* [dart-xml](https://github.com/renggli/dart-xml)
## License
Distributed under the MIT License. See `LICENSE` for more information.