Skip to content
This repository was archived by the owner on Jan 30, 2020. It is now read-only.

Updates configuration of MkDocs for Documentation #235

Merged
michalbundyra merged 3 commits into from
Oct 18, 2019
Merged

Updates configuration of MkDocs for Documentation #235

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b59ea19
Updates page names for home and introduction in MkDocs configuration
froschdesign Aug 1, 2019
88be57a
Updates site description in MkDocs configuration
froschdesign Aug 1, 2019
1145a45
Removes unneeded and outdated copyright in MkDocs configuration
froschdesign Aug 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
docs_dir: docs/book
site_dir: docs/html
pages:
- index.md
- Intro: intro.md
- Home: index.md
- Introduction: intro.md
- Reference:
- Messages:
- "Intro and Usage": message/intro.md
Expand All @@ -17,6 +17,5 @@ pages:
- "File Transport Options": transport/file-options.md
- "Reading and Storing Mail": read.md
site_name: zend-mail
site_description: zend-mail
site_description: 'Parse, create, store, and send email messages, using a variety of storage and transport protocols.'
Copy link
Member

@michalbundyra michalbundyra Oct 18, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@froschdesign are we fine with using single quotes here? I've seen usually we go with double

Copy link
Member Author

@froschdesign froschdesign Oct 18, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both are working: https://pyyaml.org/wiki/PyYAMLDocumentation#scalars

The single quotes are correct here because no escaping is needed. But we were never very strict in this topic.

repo_url: 'https://github.com/zendframework/zend-mail'
copyright: 'Copyright (c) 2005-2018 <a href="https://www.zend.com/">Zend Technologies USA Inc.</a>'