https://github.com/unknown321/azure-doc
Azure Architecture Center ebook
https://github.com/unknown321/azure-doc
azure documentation ebook epub
Last synced: about 2 months ago
JSON representation
Azure Architecture Center ebook
- Host: GitHub
- URL: https://github.com/unknown321/azure-doc
- Owner: unknown321
- Created: 2024-03-20T10:37:44.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T23:34:33.000Z (about 2 years ago)
- Last Synced: 2024-03-26T00:33:26.076Z (about 2 years ago)
- Topics: azure, documentation, ebook, epub
- Language: Go
- Homepage: https://aka.ms/architecture
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
azure-doc
=========
Creates EPUB and Markdown files from [Azure Architecture Center](https://github.com/MicrosoftDocs/architecture-center)
See:
- https://github.com/MicrosoftDocs/architecture-center/issues/1569
- https://github.com/MicrosoftDocs/architecture-center/issues/2048
Image paths in markdown are rewritten relative to `-path` option.
#### Optional dependencies:
- rsvg-convert (`librsvg2-bin` in Debian/Ubuntu), converts svg to png - most ebook devices don't support svg
#### Building
```shell
make build
```
#### Usage
```shell
Usage of ./azure-doc:
-out string
output file (default "Azure_Architecture_Center.epub")
-outMD string
output markdown file (default "Azure_Architecture_Center.md")
-path docs
path to docs dir (default "./architecture-center/docs")
```
#### Example
```shell
# downloads documentation repo into ./architecture-center
# converts svg to png with rsvg-convert for ebook readers without svg support
# assembles the epub
make
```
#### TODO
- [ ] correct cross-document links
- [ ] fix absolute yml/md paths
- [ ] fix relations tree in markdown, some nodes are not in correct position