Skip to content

Commit

Permalink
docs: fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
nobkd committed Nov 17, 2024
1 parent 598902b commit f0fd549
Show file tree
Hide file tree
Showing 18 changed files with 71 additions and 103 deletions.
2 changes: 1 addition & 1 deletion packages/examples/simple-blog/@global/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

<footer>
<navi :items="navigation.footer"/>
</footer>
</footer>
3 changes: 2 additions & 1 deletion packages/examples/simple-blog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
The default website template for `nue create` command:

<a href="https://simple-blog.nuejs.org/">
<img src="https://nuejs.org/img/blog-hero-big.png" width="700" alt="Blog screenshots"></a>
<img src="https://nuejs.org/img/blog-hero-big.png" width="700" alt="Blog screenshots">
</a>

## Links

Expand Down
2 changes: 1 addition & 1 deletion packages/examples/simple-blog/blog/blog.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@

include: [ content, cards, motion ]
include: [ content, cards, motion ]
6 changes: 3 additions & 3 deletions packages/examples/simple-blog/blog/class-naming-strategies.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ When designing for the web, keeping CSS in mind from the start prevents frustrat

Designers should have a strong handle on core CSS concepts like the box model, selectors, specificity and inheritance.

> When designing for the web, keeping CSS in mind from the start prevents frustration down the road. For example, **typography and color schemes are heavily influenced by CSS** and layered graphical elements must be broken down into achievable HTML components.
> When designing for the web, keeping CSS in mind from the start prevents frustration down the road. For example, **typography and color schemes are heavily influenced by CSS** and layered graphical elements must be broken down into achievable HTML components.
``` js.blue
function toggleAttr(el, name, flag) {
Expand All @@ -33,7 +33,7 @@ function restoreTabs(flags) {

## Exploit the power of selectors

On the development side, CSS itself involves visual design skills.Bringing a layout to life requires not just coding, but typographic, spacing and color sensibilities. CSS skills give developers control over the final look and feel.
On the development side, CSS itself involves visual design skills. Bringing a layout to life requires not just coding, but typographic, spacing and color sensibilities. CSS skills give developers control over the final look and feel.

[! img/dashboard-1.png]

Expand All @@ -56,7 +56,7 @@ Overall, CSS is a uniquely visual language, with a direct impact on user-facing

## Conclusion

In conclusion, thoughtfully naming CSS classes, IDs, and other selectors is an important part of keeping stylesheets scalable and maintainable. Use semantic, descriptive names that communicate what a selector is styling. Implement methodical naming conventions and structures for better organization
In conclusion, thoughtfully naming CSS classes, IDs, and other selectors is an important part of keeping stylesheets scalable and maintainable. Use semantic, descriptive names that communicate what a selector is styling. Implement methodical naming conventions and structures for better organization.

[! img/dashboard-2.png]

Expand Down
12 changes: 6 additions & 6 deletions packages/examples/simple-blog/blog/color-strategies.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,21 @@ Working with color is one of the most fun parts of web design. But if you don't

Choosing the right colors for a website can be tricky. Get one wrong and your entire design can feel off. Luckily, there are some simple strategies to create a foolproof web color palette:

- **Limit your palette** - Stick to just 2-4 core colors for most sites. Too many colors look disjointed.
- **Limit your palette** Stick to just 2-4 core colors for most sites. Too many colors look disjointed.

- **Focus on one dominant hue** - Pick one main color and derive the rest of the palette from it. This creates cohesion.
- **Focus on one dominant hue** Pick one main color and derive the rest of the palette from it. This creates cohesion.

- **Use color wheel relationships** - Choose adjacent or complementary colors on the wheel for built-in harmony.
- **Use color wheel relationships** Choose adjacent or complementary colors on the wheel for built-in harmony.

- **Consider tone and contrast** - Include light, medium and dark tones for visual interest. Test contrast for accessibility.
- **Consider tone and contrast** Include light, medium and dark tones for visual interest. Test contrast for accessibility.

[image img/colors-1.png]

Considering the different formatting options, you can optimize CSS color usage for any need. Use hex for one-off values, RGBA where you need opacity control, HSL for color adjustments, variables for theming, and preprocessor operations for transformations. With the right format, implementing colors in CSS becomes much more flexible and manageable.
Considering the different formatting options, you can optimize CSS color usage for any need. Use hex for one-off values, RGBA where you require opacity control, HSL for color adjustments, variables for theming, and preprocessor operations for transformations. With the right format, implementing colors in CSS becomes much more flexible and manageable.

Following these simple tips will ensure you have a tightly edited, flexible, and foolproof palette ready for your next web project.

> Focus on one dominant hue - Pick one main color and derive the rest of the palette from it. This creates cohesion.
> Focus on one dominant hue Pick one main color and derive the rest of the palette from it. This creates cohesion.
``` .pink
/* Tab styling */
Expand Down
2 changes: 1 addition & 1 deletion packages/examples/simple-blog/blog/hero.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ <h1>{ title }</h1>
</p>

<img :src="og" width="1000" height="800" alt="Hero image for { title }">
</header>
</header>
8 changes: 4 additions & 4 deletions packages/examples/simple-blog/blog/scaleable-design-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Design systems are key to managing code at scale, but creating one that’s flex

1. **Respect constraints**: Construct stylistic foundations for typography, [color palettes](color-strategies.html), spacing, etc. But don’t be overly prescriptive. Leave room for one-off deviations.

2. **Reusable components**: Break UI elements into reusable, abstracted components. A button should be built independently from where it’s used. This promotes consistency across properties and apps.
2. **Reusable components**: Break UI elements into reusable, abstracted components. A button should be built independently of where it’s used. This promotes consistency across properties and apps.

3. **Clear naming conventions**: Utilize consistent, semantic naming for classes, variables, mixins, etc. This improves developer efficiency and organization.

## Keep things minimal

It's important to keep things lightweight: Write CSS that’s DRY, separating structure from skin using methodologies like BEM. Don't over-engineer - keep logic simple.
It's important to keep things lightweight: Write CSS that’s DRY, separating structure from skin using methodologies like BEM. Don't over-engineer keep logic simple.

``` html numbered
<figure @name="img" :class="class" :id="id">
Expand All @@ -40,7 +40,7 @@ By investing in these areas, you can craft a design system that brings cohesion

[! img/ui-2.png]

Once a painting is underway, digital photography can also assist the process. Taking in-progress photos allows you to see compositions with fresh eyes. You can spot areas for improvement, mistakes that need correcting, or places that would benefit from increased attention. Like having an undo button, it gives the opportunity for editing mid-painting.
Once a painting is underway, digital photography can also assist the process. Taking in-progress photos allows you to see compositions with fresh eyes. You can spot areas for improvement, mistakes that require correcting, or places that would benefit from increased attention. Like having an undo button, it gives the opportunity for editing mid-painting.

> Put in the work upfront, and your system will pay dividends down the road.
Expand Down Expand Up @@ -68,6 +68,6 @@ Once a painting is underway, digital photography can also assist the process. Ta

By investing in these areas, you can craft a design system that brings cohesion and consistency to products, while still being flexible enough to allow for creative solutions. The ultimate goal is scalable, maintainable CSS that matches the ever-evolving needs of organizations and developers alike. Put in the work upfront, and your system will pay dividends down the road.

[image img/ui-3.png]
[! img/ui-3.png]

Using color effectively is a vital part of web design. When planned intentionally, your color palette creates visual harmony across your website or application. A cohesive color scheme boosts recognition of your brand, while making the interface feel cohesive.
2 changes: 1 addition & 1 deletion packages/examples/simple-blog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ content_collection: blog

# Minimalist, UX developer, designer, urban explorer

I'm Emma Bennett, an user experience developer from Berlin. I build websites that are exceptionally well designed — inside, and outside.
I'm Emma Bennett, a user experience developer from Berlin. I build websites that are exceptionally well-designed — inside, and outside.

[page-list]
3 changes: 0 additions & 3 deletions packages/examples/simple-blog/site.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,3 @@ navigation:
url: //linkedin.com/in/tipiirai
alt: LinkedIn profile
size: 22 x 22



9 changes: 2 additions & 7 deletions packages/nuejs.org/blog/introducing-glow/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Today we're launching *Glow* — a new take on syntax highlighting:

*Glow is simple*: With just a few CSS variables, Glow adapts all languages to match your brand colors effortlessly.

*Glow is small*: Glow is significantly smaller than mainstream alternativesaround [5KB](//pkg-size.dev/nue-glow) compared to [5MB](//pkg-size.dev/shiki). It’s the most compact implementation available.
*Glow is small*: Glow is significantly smaller than mainstream alternativesaround [5KB](//pkg-size.dev/nue-glow) compared to [5MB](//pkg-size.dev/shiki). It’s the most compact implementation available.


[image.tall]
Expand Down Expand Up @@ -67,7 +67,7 @@ Contrast this to grammar-aware theming systems, like Shiki and *Prism*, where a


## Unlimited possibilities
Glow's unique, [classless design system](/docs/syntax-highlighting.html#html-markup) gives you line numbers, selections, error highlights, insertions, deletions, and much much more.
Glow's unique, [classless design system](/docs/syntax-highlighting.html#html-markup) gives you line numbers, selections, error highlights, insertions, deletions, and much, much more.

``` .gradient.sky numbered
<script>
Expand Down Expand Up @@ -199,8 +199,3 @@ Now you can enjoy goodies content hot-reloading when the code blocks are edited:
videoId: 38caf489-74f1-416a-9f23-694baa5500bb
caption: Nue hot-reloading in action
poster: thumbnail_1ca1bd66.jpg





5 changes: 1 addition & 4 deletions packages/nuejs.org/blog/nue-release-candidate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Surprisingly, these rich, interactive sites remain exceptionally lightweight, co
## New Markdown parser
In earlier versions of Nue, we used the **Marked** library to handle basic formatting for our extended Markdown syntax — known as **Nuemark**. While Marked is a solid, general-purpose Markdown parser with excellent performance, it became clear that it couldn't fully support the direction we wanted for Nue, particularly with our content-first development model.

The main issue with Marked was its lack of a mutable **abstract syntax tree** (AST). The AST is a structured representation of the Markdown content, allowing it to be easily analyzed, manipulated, and extended before rendering to HTML. With Marked, the structure was essentially immutablemeaning it wasn't possible to add new nodes, elements, or link references before rendering the document.
The main issue with Marked was its lack of a mutable **abstract syntax tree** (AST). The AST is a structured representation of the Markdown content, allowing it to be easily analyzed, manipulated, and extended before rendering to HTML. With Marked, the structure was essentially immutablemeaning it wasn't possible to add new nodes, elements, or link references before rendering the document.

Moreover, the API for creating custom extensions was overly complex, particularly for advanced features that needed to understand the document’s structure and modify parts of the syntax tree. This made implementing the more advanced components of Nue impossible.

Expand Down Expand Up @@ -202,6 +202,3 @@ Full list of improvements and breaking changes on this release:
- **`[image]` "srcset" removed**: The `srcset` and `sizes` parameters for the `[image]` tag have been removed due to their complexity. A simpler and more powerful system for responsive images is planned for future releases.

- **`[video]` tag simplified**: The `[video]` tag has been simplified to only accept the `src` parameter, removing support for multiple video sources. A more robust video player and driver support system is coming in a future update, allowing for better video handling and greater flexibility.



20 changes: 9 additions & 11 deletions packages/nuejs.org/docs/content-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ Nue supports common **Markdown extensions** such as **tables** and **footnotes**
Tables are useful for presenting structured information. Here’s an example:

```md
| Principle | Description |
|--------------------------|-------------------------------------------------------------------|
| Separation of Concerns | Dividing a system into distinct sections with specific roles. |
| Progressive Enhancement | Building core functionality first, then adding enhanced features. |
| Information Architecture | Structuring content for usability and navigation clarity. |
\| Principle | Description |
\|--------------------------|-------------------------------------------------------------------|
\| Separation of Concerns | Dividing a system into distinct sections with specific roles. |
\| Progressive Enhancement | Building core functionality first, then adding enhanced features. |
\| Information Architecture | Structuring content for usability and navigation clarity. |
```

This table provides a simple breakdown of key principles.
Expand Down Expand Up @@ -310,7 +310,7 @@ This allows flexible layout creation, giving you control over content structure

1. **Create complex layouts with pure content**: There's literally zero bloat or extra markup needed to achieve advanced layouts such as **flex** or **grid**. Your design system’s CSS components handle the layout, keeping your Markdown clean and focused on content.

2. **Supports rich, flexible designs**: You can easily render complex, visually engaging layouts like **bento-style cards** that mix videos, images, and text**optionally enhanced** with scripting and motion. This flexibility allows you to create stunning, content-rich sections that work seamlessly across devices, without touching a line of HTML.
2. **Supports rich, flexible designs**: You can easily render complex, visually engaging layouts like **bento-style cards** that mix videos, images, and text**optionally enhanced** with scripting and motion. This flexibility allows you to create stunning, content-rich sections that work seamlessly across devices, without touching a line of HTML.

### Nesting
Blocks can be nested to form more complex layouts on your richer marketing and landing pages, giving you the flexibility to create structured, multi-layered content without ever touching HTML. For example:
Expand All @@ -330,7 +330,7 @@ Blocks can be nested to form more complex layouts on your richer marketing and l

This creates a flexible layout where a main **feature** block contains a nested **stack**, allowing for clean organization and structure in your content.

The possibilities are endless. You can combine blocks in creative ways, stacking sections within sections to build rich, interactive landing pages. Imagine a **hero section** that introduces key features, followed by a **grid of cards**, each with its own stacked content blocks highlighting product details, testimonials, or case studies. With the power of **nesting**, you can craft visually complex layouts while keeping your Markdown easy to read and maintain. Whether you're building product showcases, multi-section promotional pages, or detailed service breakdowns, nesting unlocks a new level of creative control over your content structureletting design systems handle the visual complexity.
The possibilities are endless. You can combine blocks in creative ways, stacking sections within sections to build rich, interactive landing pages. Imagine a **hero section** that introduces key features, followed by a **grid of cards**, each with its own stacked content blocks highlighting product details, testimonials, or case studies. With the power of **nesting**, you can craft visually complex layouts while keeping your Markdown easy to read and maintain. Whether you're building product showcases, multi-section promotional pages, or detailed service breakdowns, nesting unlocks a new level of creative control over your content structureletting design systems handle the visual complexity.

### Code blocks
Code blocks in Nue are enclosed between triple backticks and can include an optional language hint for syntax highlighting using the [Glow syntax highlighter](/blog/introducing-glow/). For example, a CSS code block would look like this:
Expand Down Expand Up @@ -414,7 +414,7 @@ These **two words** are highlighted and **these words** are erroneous.
#### Mixing content blocks and code blocks
Here's an example combining content blocks and code blocks. Notice how clean the syntax is, avoiding excessive coding and ugly markup that often comes with complex layouts:

```md
````md
[.stack]

### CSS animation setup
Expand All @@ -441,13 +441,11 @@ Here's an example combining content blocks and code blocks. Notice how clean the
background-color: #ff4081;
}
```
```
````

This simple example demonstrates how you can create a **stacked layout** with content and code blocks, all within a clean, readable format. Mixing content and code blocks in this way allows you to present complex technical concepts, tutorials, or style guides without sacrificing readability or maintainability.

### Content tags
Nue offers a large amount of [tags](content-tags.html) that significantly enhance your ability to create rich and interactive websites. You can add responsive images, videos, buttons, accordions, tabs, and more.

You can also extend the syntax with [custom components](custom-components.html).
Loading

0 comments on commit f0fd549

Please sign in to comment.