X Tutup
Skip to content

feat: update page object #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
azu merged 2 commits into from
Dec 24, 2021
Merged

feat: update page object #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87f8224
feat: add articles to page object
Yilun-Sun Dec 22, 2021
dae56b4
docs: update hooks document
Yilun-Sun Dec 22, 2021
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
21 changes: 20 additions & 1 deletion docs/plugins/hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,26 @@ Hooks is a method of augmenting or altering the behavior of the process, with cu
// Content of the page
// Markdown/Asciidoc in "page:before"
// HTML in "page"
"content": "# Hello"
"content": "<h1>Hello</h1>"

// Level of the page
"level": "1.5.3.1"

// Depth of the page
"depth": "3"
Copy link
Member

@azu azu Jan 17, 2022

Choose a reason for hiding this comment

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

I've noticed that the depth is number?

Copy link
Contributor Author

@Yilun-Sun Yilun-Sun Jan 18, 2022

Choose a reason for hiding this comment

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

yes, it's the distance from the root in the page tree


// Other attributes appear in the .md between two '---' at the beginning of the content
// For example in the front of the markdown:
// ---
// description: This is a description
// ---
"description": "This is a description"

// Previous article
"previous": Article Object

// Next article
"next": Article Object
}
```

Expand Down
8 changes: 8 additions & 0 deletions packages/honkit/src/json/encodePage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ function encodePage(page: Page, summary: Summary): EncodedPage {
if (prevArticle) {
result.previous = encodeSummaryArticle(prevArticle);
}

const articles = article
.getArticles()
.map((article) => encodeSummaryArticle(article))
.toJS();
if (articles.length > 0) {
result.articles = articles;
}
}

result.content = page.getContent();
Expand Down
X Tutup