Possible alternatives for authoring blog posts

Open
#796 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript, jupyter-notebook, nextjs, react

Research direction

Begin with the README tips added in #795 and inspect the existing Blog section. Compare the notebook-to-HTML approach in Jupyter Book with the structure of xarray-indexes; the issue is done only when a concrete authoring approach and its documentation or machinery are defined.

Written by the indexing model from the issue text.

Description

While the end product looks nice, I found authoring a blog post to currently be a bit cumbersome in #795, so I added a few tips on the process to the end of the readme.

But eventually it could be nice to revamp the authoring setup. While some posts are text only, it's likely a lot of posts could be written as a single executable notebook, so having machinery or documentation (https://github.com/jupyter-book/jupyter-book ?) to go from notebook->HTML would be great.

However, I'm not really familiar with javascript and know of a way to simple insert the output from a markdown->HTML converter to a page on this website? Or maybe the entire 'Blog' section could be handled in it's own repo with a structure like https://xarray-indexes.readthedocs.io ?...

Dominant language
JavaScript
Stars
14
Forks
30
Avg merge
6h 47m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from xarray-contrib/xarray.dev

All issues in xarray-contrib/xarray.dev

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.