diff --git a/README.md b/README.md index b490bf9..fee72c9 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ This bundle will help you synchronise your project's newsletter subscribers into ## Features * [x] Use your own userProvider (basic `FosSubscriberProvider` included to interface with FosUserBundle) +* [x] Use your own listProvider (`DoctrineListProvider` included to retrieve your list from a database) * [x] Synchronize Merge Fields with your config * [x] Synchronize your subscriber with a List * [x] Use lifecycle event to subscribe/unsubscribe/delete subscriber from a List @@ -52,6 +53,7 @@ Look at the full documentation at * Setup * Configuration * Subscriber Provider +* List Provider * Usage * Synchronize merge fields * Full synchronization with command diff --git a/mkdocs.yml b/mkdocs.yml index 9362132..2356359 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,3 +18,5 @@ pages: - MailChimp Doc: mailchimp-doc.md - Contributing: CONTRIBUTING.md theme: readthedocs +markdown_extensions: + - pymdownx.github diff --git a/src/Resources/doc/documentation.md b/src/Resources/doc/documentation.md new file mode 100644 index 0000000..06fa07f --- /dev/null +++ b/src/Resources/doc/documentation.md @@ -0,0 +1,8 @@ +# Documentation + +You can read files in the folder `src/Resources/doc` or you can compile the documentation with MkDocs: + +* Install Python 2.7 and Pip 1.5 +* Install MkDocs: `pip install mkdocs` +* Install pymdown-extension: `pip install pymdown-extensions` +* Compile the doc: `mkdocs build` or to preview the doc: `mkdocs serve` at diff --git a/src/Resources/doc/index.md b/src/Resources/doc/index.md index b338965..7696bff 100644 --- a/src/Resources/doc/index.md +++ b/src/Resources/doc/index.md @@ -10,6 +10,7 @@ This bundle will help you synchronise your project's newsletter subscribers into ## Features * [x] Use your own userProvider (basic `FosSubscriberProvider` included to interface with FosUserBundle) +* [x] Use your own listProvider (`DoctrineListProvider` included to retrieve your list from a database) * [x] Synchronize Merge Fields with your config * [x] Synchronize your subscriber with a List * [x] Use lifecycle event to subscribe/unsubscribe/delete subscriber from a List @@ -49,6 +50,7 @@ More configuration on the [documentation](configuration.md). * [Setup](setup.md) * [Configuration](configuration.md) * [Subscriber Provider](subscriber-provider.md) +* [List Provider](list-provider.md) * [Usage](usage.md) * Synchronize merge fields * Full synchronization with command