feat: site with mdbook

[jcstein]

Overview

TODO

• set up mdbook with same file structure (i.e. /cips stays, becomes default src dir, and /wgs move to /cips/wgs)
• custom handling for frontmatter in CIPs, use option 2 from here feat: site with mdbook #170 (comment)
• set up dns
• test out on personal github pages https://cips.jcstein.dev
• prep for plausible
  • add plausible script
• favicon
• prep site for dns

The previous PR got too messy and I'd like to try without moving the structure around. #168

[jcstein]

Options for frontmatter:

1. change the styling to have backticks around it and display the code block

this also works on github

2. change the style of the frontmatter itself to be .md-friendly instead of github-flavored-markdown friendly

IMHO this looks worse

3. use GFM-styled table

cip	title	author	status	type	created
1	Celestia Improvement Proposal Process and Guidelines	Yaz Khoury [email protected]	Living	Meta	2023-04-13

[jcstein]

edge case for option 3 is that you can't see the whole table

but if it is a code block, you can. no scrolling

[jcstein]

i'm actually not sure what's best here 😅
it's pretty janky to scroll through the code block

[jcstein]

demo: https://cips.jcstein.dev/
diff for final touches: jcs/add-site-v0...jcstein:CIPs:main

once this is approved, 2 things will need to happen before going live:

1. @sysrex to add DNS for cips.celestia.org for github pages deployment. this should just be adding a CNAME entry for "cips" since gh pages is already setup for the A records of celestia.org
2. @musalbas to begin collecting plausible analytics. it's already set up on the site's end

   CIPs/theme/head.hbs

   Line 1 in 2bedecf

   <script defer data-domain="cips.celestia.org" src="https://plausible.celestia.org/js/plausible.js"></script>

[rootulp]

Overall LGTM, thanks for all your hard work on this!

[musalbas]

GFM style tables look very annoying to edit for CIP authors and look worse rendered to me. Why do you think it looks worse than option 2?

[jcstein]

I think options 2 and 3 are equally as annoying to edit/author and neither is perfect. GFM just fits into the current style that is displayed on github

[musalbas]

I don't follow how, as option 2 just requires the author to write bulletpoints whereas option 3 requires them to add a bunch of ------ ascii art and scroll right to see the whole text, and disable text wrap

[jcstein]

I see, the table for option 2 is easier to edit. i will demo on this PR

| cip | 1 |
| - | - |
| title | Celestia Improvement Proposal Process and Guidelines |
| author | Yaz Khoury <[email protected]> |
| status | Living |
| type | Meta |
| created | 2023-04-13 |

renders:

cip	1
title	Celestia Improvement Proposal Process and Guidelines
author	Yaz Khoury [email protected]
status	Living
type	Meta
created	2023-04-13