Commit a185471d authored by Dominique Feyer's avatar Dominique Feyer

[TASK] Add basic documentation

parent a1cb0fc2
# Sitemap Package for big website based on Neos CMS
This package provide the infrastrucutre to build sitemap.xml for big website based on [Neos CMS](https://www.neos.io)
This package use job queue to generate a static sitemap.xml when a node path change. You can configure how the sitemap
build should work by different presets.
**Package under development, API can change at any time**
How to use ?
------------
Edit your distribution [Settings.yaml](Configuration/Settings.yaml) for configuration:
Ttree:
Neos:
Sitemap:
presets:
default:
include:
'TYPO3.Neos.NodeTypes:Page': TRUE
skip:
'TYPO3.Neos:Shortcut': TRUE
type: 'single'
Basically you can configure the NodeType who need to be in the sitemap, and an optional list of NodeType that need to
be skipped.
Currently to Job Queue is not supported but you can use the CLI command::
```
FLOW_REWRITEURLS=1 ./flow sitemap:generate --site-node-name architectesch --base-url http://www.architectes.ch/ --preset default
```
__Warning__: The environnement variable ```FLOW_REWRITEURLS``` is required in CLI to have proper URI building
What's next ?
-------------
- Implement type: "multiple", to generate multiple sitemap with one index
- Implement asynchronous sitemap generation based on Job Queue
- Integrate with Neos.SEO package for advanced configuration per document
Acknowledgments
---------------
Development sponsored by [ttree ltd - neos solution provider](http://ttree.ch).
We try our best to craft this package with a lots of love, we are open to
sponsoring, support request, ... just contact us.
License
-------
Licensed under MIT, see [LICENSE](LICENSE)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment