Skip to content

Commit

Permalink
Merge pull request #865 from orbitjs/welcome-post
Browse files Browse the repository at this point in the history
Update welcome blog post
  • Loading branch information
dgeb authored Jul 16, 2021
2 parents 857efa8 + e63f14c commit 14519a7
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 12 deletions.
11 changes: 0 additions & 11 deletions website/blog/2021-07-12-welcome.md

This file was deleted.

27 changes: 27 additions & 0 deletions website/blog/2021-07-16-welcome-to-the-new-orbitjs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Welcome to the new Orbitjs.com
author: Dan Gebhardt
author_title: Orbit.js Creator
author_url: https://github.com/dgeb
author_image_url: https://avatars.githubusercontent.com/u/29122?v=4
tags: [documentation, docusaurus]
---

I'm excited to announce a complete refresh of Orbitjs.com! 🎉

Our site has been rebuilt using [Docusaurus](https://docusaurus.io/). The
source for this site now lives in [Orbit's
monorepo](https://github.com/orbitjs/orbit/tree/main/website) right alongside
the packages that it describes. This will make it easier to update docs along
with code, preferably even in the same PRs.

I'm especially excited to announce that we are finally publishing API reference
docs, generated with [TypeDoc](https://typedoc.org/), alongside the Orbit
guides. The first API docs available are for the upcoming v0.17, which can be
accessed directly [here](/docs/next/api) or by choosing `Next` from the
documentation version selector in the upper right.

While the current API docs are much better than nothing, the prose and examples
are pretty thin for most packages. Please be patient as we work to fill out
these docs through improved code annotations. Community contributions are
encouraged and most welcome! ❤️
9 changes: 8 additions & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -423,8 +423,15 @@ module.exports = {
editUrl: 'https://github.com/orbitjs/orbit/edit/main/website/'
},
blog: {
path: 'blog',
blogSidebarCount: 'ALL',
blogSidebarTitle: 'All Blog Posts',
showReadingTime: true,
editUrl: 'https://github.com/orbitjs/orbit/edit/main/website/blog/'
editUrl: 'https://github.com/orbitjs/orbit/edit/main/website/blog/',
feedOptions: {
type: 'all',
copyright: `Copyright © 2014-${new Date().getFullYear()} Cerebris Corporation`,
},
},
theme: {
customCss: require.resolve('./src/css/custom.scss')
Expand Down

0 comments on commit 14519a7

Please sign in to comment.