docs(README): add manifest example
This commit is contained in:
parent
d6112ccb2c
commit
37fec5fd07
1 changed files with 41 additions and 0 deletions
41
README.md
41
README.md
|
|
@ -18,6 +18,47 @@ For a reference implementation of an external publisher, please refer to
|
||||||
[PSConfluencePublisher](https://bitbucket.org/victorykit/psconfluencepublisher),
|
[PSConfluencePublisher](https://bitbucket.org/victorykit/psconfluencepublisher),
|
||||||
a standalone PowerShell publisher for *Atlassian Confluence Builder for Sphinx*.
|
a standalone PowerShell publisher for *Atlassian Confluence Builder for Sphinx*.
|
||||||
|
|
||||||
|
The following is a sample manifest generated from the default sample:
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"Pages": [
|
||||||
|
{
|
||||||
|
"Title": "Default Sample~",
|
||||||
|
"Ref": "pages/Default+Sample~.xml"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Title": "Cats",
|
||||||
|
"Ref": "pages/Cats.xml",
|
||||||
|
"AncestorTitle": "Default Sample~"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"Attachments": [
|
||||||
|
{
|
||||||
|
"Name": "pexels-just-a-couple-photos-3777622.jpg",
|
||||||
|
"ContainerPageTitle": "Cats",
|
||||||
|
"MimeType": "image/jpeg",
|
||||||
|
"Ref": "attachments/pexels-just-a-couple-photos-3777622.jpg"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Name": "pexels-sami-aksu-14356302.jpg",
|
||||||
|
"ContainerPageTitle": "Cats",
|
||||||
|
"MimeType": "image/jpeg",
|
||||||
|
"Ref": "attachments/pexels-sami-aksu-14356302.jpg"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Name": "objects.inv",
|
||||||
|
"ContainerPageTitle": "Default Sample~",
|
||||||
|
"MimeType": "application/octet-stream",
|
||||||
|
"Ref": "attachments/objects.inv"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
> **NOTE**: The manifest's schema is currently part of the
|
||||||
|
[PSConfluencePublisher](https://bitbucket.org/victorykit/psconfluencepublisher)
|
||||||
|
|
||||||
## Installing
|
## Installing
|
||||||
|
|
||||||
You can install this extension via PyPI (through pip):
|
You can install this extension via PyPI (through pip):
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue