Skip to content
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.

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

Website redesign using Markdown & VitePress default theme #21

Merged
merged 30 commits into from
Feb 29, 2024

Conversation

jcbhmr
Copy link
Contributor

@jcbhmr jcbhmr commented Feb 7, 2024

Formal PR to close #20

interesting reading on documentation design https://diataxis.fr/

PREVIEW IT HERE

These PRs should be merged first:


This PR would:

Advantages of VitePress over current Jekyll theme:

  • uses Markdown -- MUCH more popular (~83x more popular to be exact md vs adoc)
  • no layouts; using premade theme
  • syntax highlighting

Disadvantages of VitePress over current Jekyll theme:

  • might not match the bland plain look of other https://open.ribose.com/ stuff
  • built more for docs, less for blogs 🤷‍♂️ (at least what's included by default; there are plugins/themes/scripts/etc)

Advantages of using in-repo GitHub Pages sites:

  • strong coupling of behaviour to docs (they're in the same repo VS in separate repos)
  • makes it wayyy easier too manage changes to the docs & code in one PR vs two prs on separate repos

Depending on whether or not you care about maintaining link-compatibility with the old site you could simplify things a bit more and get rid of all the files that are essentially just this (ripped from the Rollup.js website https://github.com/rollup/rollup/blob/master/docs/guide/en.md?plain=1)

Redirecting...

<script setup>
import { useRouter } from "vitepress"; 

if (typeof window !== "undefined") {
  const { go } = useRouter();
  go(`/guide/en/${location.hash}`);
  // OR
  location.replace("https://fontist.org/other-project/sub-page.html");
}
</script>

Depending on how much complexity you want, there are other fancier ways to do a VitePress blog to varying degrees of "bloggy-ness" (vs just page-ness)

Given how sparse the current blog is I'd just rely on manual editing until/unless you really get blogging. Right now there is one post lol 😂

pssst! "Allow edits by maintainers" is checked; feel free to edit

open and edit in Codeflow (in browser Node.js IDE) https://pr.new/https://github.com/jcbhmr/fontist.github.io

@jcbhmr jcbhmr changed the title Website redesign Website redesign using Markdown & VitePress default theme Feb 7, 2024
@ronaldtse
Copy link
Contributor

Depending on whether or not you care about maintaining link-compatibility with the old site

No, we don't really care at this point...

@ronaldtse ronaldtse merged commit 8c86f7a into fontist:main Feb 29, 2024
@ronaldtse
Copy link
Contributor

@jcbhmr The PRs have been merged and now deployed! Thank you for the amazing work!

Screenshot 2024-02-29 at 9 56 46 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Open to website redesign?
2 participants