Skip to content

Commit b3ad092

Browse files
committed
Clean up landing page and improve dev docs
1 parent 31ce07f commit b3ad092

File tree

4 files changed

+39
-13
lines changed

4 files changed

+39
-13
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
# MyST build outputs
22
_build
3+
node_modules

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,21 @@
1-
# blog
2-
Blog for the Jupyter Book subproject
1+
# The Jupyter Book blog
2+
3+
A blog for the Jupyter Book subproject.
4+
5+
## Local development
6+
7+
This blog is a small [MyST site](https://mystmd.org) along with a [javascript plugin for blogging](plugins/blog.mjs).
8+
9+
To run it locally, take these steps:
10+
11+
1. **Install NPM and MyST** by [following the MyST installation instructions](https://mystmd.org/guide/installing).
12+
2. **Install the plugin requirements** with NPM:
13+
14+
```shell
15+
$ npm install
16+
```
17+
3. **Build the site**:
18+
19+
```shell
20+
$ myst start
21+
```

index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
11
---
22
site:
33
hide_title_block: true
4+
hide_outline: true
45
---
56

67
# Blog
78

9+
% This is a hack because hiding the title block removes the margin and title
10+
% Whereas we just want to remove the button links etc.
11+
<div style="margin-top: 1em;">
12+
13+
## Welcome to the Jupyter Book blog! 👋
14+
15+
</div>
16+
17+
This is a place for [the Jupyter Book team](https://compass.jupyterbook.org) to share updates from the community and the project.[^ebp]
18+
19+
[^ebp]: See the [Executable Books blog](https://executablebooks.org/en/latest/blog/) for blog posts from when Jupyter Book was a part of the Executable Books project. See this [post about moving to Jupyter](posts/2024-11-11-jupyter-book-org.md) for context on the move from Executable Books to Jupyter.
20+
21+
## Recent blog posts
22+
823
:::{blog-posts}
924
:::

plugins/blog.mjs

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,8 @@ const blogPostsDirective = {
2828
? [
2929
{
3030
type: "footer",
31-
children: [
32-
{
33-
type: "paragraph",
34-
children: [
35-
{
36-
type: "text",
37-
value: `Date: ${frontmatter.date}`,
38-
},
39-
],
40-
},
41-
],
31+
// Pull out the first child of `root` node.
32+
children: [ctx.parseMyst(`**Date**: ${frontmatter.date}`)["children"][0]],
4233
},
4334
]
4435
: [];

0 commit comments

Comments
 (0)