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

Add note about trying out Polaris #1618

Merged
merged 5 commits into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion apps/tutorial/app/components/prose/highlight.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,22 @@ export async function getHighlighter(): Promise<HLJSApi> {
* since we now use hljs on initial page load, eagerly, we want to load
* as little as possible
*/
let [hljs, glimmer, javascript, typescript, markdown, css] = await Promise.all([
let [hljs, glimmer, javascript, typescript, markdown, css, bash] = await Promise.all([
import('highlight.js/lib/core'),
import('highlightjs-glimmer'),
import('highlight.js/lib/languages/javascript'),
import('highlight.js/lib/languages/typescript'),
import('highlight.js/lib/languages/markdown'),
import('highlight.js/lib/languages/css'),
import('highlight.js/lib/languages/bash'),
]);

HIGHLIGHT = hljs.default;
HIGHLIGHT.registerLanguage('javascript', javascript.default);
HIGHLIGHT.registerLanguage('typescript', typescript.default);
HIGHLIGHT.registerLanguage('markdown', markdown.default);
HIGHLIGHT.registerLanguage('css', css.default);
HIGHLIGHT.registerLanguage('bash', bash.default);

glimmer.setup(HIGHLIGHT);

Expand Down
27 changes: 26 additions & 1 deletion apps/tutorial/public/docs/1-introduction/1-basics/prose.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,13 @@ However, manually typing in the editor for each example is a more effective way

On smaller screens, there is a button in the bottom right of the screen so that slides the tutorial text out of the way so that the editor can be interacted with.

<p class="call-to-play">
Callouts like these will be present in tutorials to guide focus, and be clear about what you're expected to do in a particular exercise.
</p>

This entire app is generated from [the docs folder][the-docs] and content can be edited, previewed, and created all within the GitHub UI. No need to download or install anything to contribute.

[the-docs]: https://github.com/NullVoxPopuli/limber/tree/main/apps/tutorial/docs
[the-docs]: https://github.com/NullVoxPopuli/limber/tree/main/apps/tutorial/public/docs

## What are components?

Expand Down Expand Up @@ -124,3 +128,24 @@ However, because there are a number of more foundational concepts to cover, this
[Signals]: https://www.solidjs.com/tutorial/introduction_signals
[Runes]: https://svelte.dev/blog/runes
[tracked]: https://guides.emberjs.com/release/components/component-state-and-actions/#toc_tracked-properties

## How do I get started with a bleeding-edge Ember app today?

- For Webpack:
```bash
git clone --branch webpack git@github.com:NullVoxPopuli/polaris-starter.git
cd polaris-starter
pnpm install
pnpm start
```
Or try it out on [Stackblitz](https://stackblitz.com/github/nullVoxPopuli/polaris-starter/tree/webpack?file=README.md) (however, Stackblitz may be [broken with Webpack](https://github.com/stackblitz/core/issues/2926) atm)

- For Vite (alpha / unstable)
```bash
git clone git@github.com:NullVoxPopuli/polaris-starter.git
cd polaris-starter
pnpm install
pnpm start
```
Or try it out on [Stackblitz](https://stackblitz.com/github/nullVoxPopuli/polaris-starter/tree/main?file=README.md)

37 changes: 36 additions & 1 deletion pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading