Skip to content

Commit

Permalink
Merge pull request #813 from Molochem/main
Browse files Browse the repository at this point in the history 
Fixed Various Typos, Grammatical Errors and some Code Snippets
  • Loading branch information
@stevepiercy
stevepiercy authored Oct 17, 2023
2 parents 9d85b76 + 7744569 commit 772c94c
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 46 deletions.
2 changes: 1 addition & 1 deletion docs/voltohandson/breadcrumbs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ myst:

We want to hide breadcrumbs from the homepage and change the styling a bit.

We can do it by using bare styling, since Volto injects CSS classes in the body that help us to style depending on the object, the content type and the path.
We can do it by using bare styling, since Volto injects CSS classes in the body that help us to style, depending on the object, the content type, and the path.
Volto does it very much like Plone does.

```less
Expand Down
94 changes: 54 additions & 40 deletions docs/voltohandson/footer.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,118 +34,130 @@ Then, we replace the `Footer` component content to match the one from plone.org.
<Grid.Column>
<List>
<List.Header>
<Link to="/why-plone">About Plone</Link>
<UniversalLink href="/why-plone">About Plone</UniversalLink>
</List.Header>
<List.Content>
<List.Item>
<Link to="/try-plone">Try Plone</Link>
<UniversalLink href="/try-plone">Try Plone</UniversalLink>
</List.Item>
<List.Item>
<Link to="/download">Download Plone</Link>
<UniversalLink href="/download">
Download Plone
</UniversalLink>
</List.Item>
<List.Item>
<a href="https://6.docs.plone.org">Documentation</a>
<UniversalLink href="https://6.docs.plone.org">Documentation</UniversalLink>
</List.Item>
<List.Item>
<a href="https://training.plone.org">Training</a>
<UniversalLink href="https://training.plone.org">Training</UniversalLink>
</List.Item>
<List.Item>
<Link to="/security">Security</Link>
<UniversalLink href="/security">Security</UniversalLink>
</List.Item>
<List.Item>
<Link to="/roadmap">Roadmap</Link>
<UniversalLink href="/roadmap">Roadmap</UniversalLink>
</List.Item>
<List.Item>
<a href="https://github.com/plone">Github</a>
<UniversalLink href="https://github.com/plone">Github</UniversalLink>
</List.Item>
</List.Content>
</List>
</Grid.Column>
<Grid.Column>
<List>
<List.Header>
<Link to="/community">Community</Link>
<UniversalLink href="/community">Community</UniversalLink>
</List.Header>
<List.Content>
<List.Item>
<a href="https://community.plone.org/">Forum</a>
<UniversalLink href="https://community.plone.org/">Forum</UniversalLink>
</List.Item>
<List.Item>
<Link to="/community/chat">Chat</Link>
<UniversalLink href="/community/chat">Chat</UniversalLink>
</List.Item>
<List.Item>
<Link to="/contribute">Contribute code</Link>
<UniversalLink href="/contribute">
Contribute code
</UniversalLink>
</List.Item>
<List.Item>
<a href="/community/bugs">Report an issue</a>
<UniversalLink href="/community/bugs">Report an issue</UniversalLink>
</List.Item>
<List.Item>
<Link to="/news-and-events">News and events</Link>
<UniversalLink href="/news-and-events">
News and events
</UniversalLink>
</List.Item>
<List.Item>
<a href="https://ploneconf.org">Conference</a>
<UniversalLink href="https://ploneconf.org">Conference</UniversalLink>
</List.Item>
</List.Content>
</List>
</Grid.Column>
<Grid.Column>
<List>
<List.Header>
<Link to="/foundation">Foundation</Link>
<UniversalLink href="/foundation">Foundation</UniversalLink>
</List.Header>
<List.Content>
<List.Item>
<Link to="/foundation/members/application-procedure">
<UniversalLink href="/foundation/members/application-procedure">
Join the foundation
</Link>
</UniversalLink>
</List.Item>
<List.Item>
<Link to="/foundation/board">Board</Link>
<UniversalLink href="/foundation/board">
Board
</UniversalLink>
</List.Item>
<List.Item>
<a href="https://github.com/sponsors/plone">Donate</a>
<UniversalLink href="https://github.com/sponsors/plone">Donate</UniversalLink>
</List.Item>
<List.Item>
<Link to="/foundation/sponsorship">Sponsors</Link>
<UniversalLink href="/foundation/sponsorship">
Sponsors
</UniversalLink>
</List.Item>
<List.Item>
<Link to="/foundation/materials/foundation-resolutions/code-of-conduct">
<UniversalLink href="/foundation/materials/foundation-resolutions/code-of-conduct">
Code of conduct
</Link>
</UniversalLink>
</List.Item>
<List.Item>
<Link to="/foundation/members">Foundation members</Link>
<UniversalLink href="/foundation/members">
Foundation members
</UniversalLink>
</List.Item>
<List.Item>
<a href="https://plone.teemill.com/">Shop</a>
<UniversalLink href="https://plone.teemill.com/">Shop</UniversalLink>
</List.Item>
</List.Content>
</List>
</Grid.Column>
<Grid.Column className="separated">
<List>
<List.Header>
<Link to="/news-and-events/plone-in-social-media">
<UniversalLink href="/news-and-events/plone-in-social-media">
Follow us
</Link>
</UniversalLink>
</List.Header>
<List.Content>
<Grid textAlign="left" columns={2}>
<Grid.Column>
<List>
<List.Content>
<List.Item>
<a href="https://plone.social/@plone" rel="me">
<UniversalLink href="https://plone.social/@plone" rel="me">
Mastodon
</a>
</UniversalLink>
</List.Item>
<List.Item>
<a href="https://twitter.com/plone">Twitter</a>
<UniversalLink href="https://twitter.com/plone">Twitter</UniversalLink>
</List.Item>
<List.Item>
<a href="https://www.instagram.com/plonecms/">
<UniversalLink href="https://www.instagram.com/plonecms/">
Instagram
</a>
</UniversalLink>
</List.Item>
</List.Content>
</List>
Expand All @@ -154,19 +166,19 @@ Then, we replace the `Footer` component content to match the one from plone.org.
<List>
<List.Content>
<List.Item>
<a href="https://www.youtube.com/@plonecms">
<UniversalLink href="https://www.youtube.com/@plonecms">
YouTube
</a>
</UniversalLink>
</List.Item>
<List.Item>
<a href="https://www.linkedin.com/company/plone-foundation/">
<UniversalLink href="https://www.linkedin.com/company/plone-foundation/">
Linkedin
</a>
</UniversalLink>
</List.Item>
<List.Item>
<a href="https://www.facebook.com/plonecms">
<UniversalLink href="https://www.facebook.com/plonecms">
Facebook
</a>
</UniversalLink>
</List.Item>
</List.Content>
</List>
Expand All @@ -177,7 +189,9 @@ Then, we replace the `Footer` component content to match the one from plone.org.
<List>
<List.Header>
<List.Item>
<Link to="/privacy-policy">Privacy Policy</Link>
<UniversalLink href="/privacy-policy">
Privacy Policy
</UniversalLink>
</List.Item>
</List.Header>
<List.Content>
Expand Down Expand Up @@ -210,7 +224,7 @@ Then, we replace the `Footer` component content to match the one from plone.org.
</div>
```

and add this styling to the `custom.overrides` file:
And add this styling to the `custom.overrides` file:

```less
//Footer
Expand Down
2 changes: 1 addition & 1 deletion docs/voltohandson/introtoblocks.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ export { SliderBlockEdit, SliderBlockView };
We need to configure the project to make it aware of a new block by adding it to the object configuration for that we need the 2 blocks components we created and a svg icon that will be displayed in the blocks chooser. This will again be done in the projects config file:

```js
import { SliderBlockView, SliderBlockEdit } from "@package/components";
import { SliderBlockView, SliderBlockEdit } from "./components/";
import heroSVG from "@plone/volto/icons/hero.svg";
```

Expand Down
9 changes: 5 additions & 4 deletions docs/voltohandson/starttheming.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Finally edit your `theme.config` and change the `@siteFolder` variable to contai

## Basic font family

[plone.org](plone.org) uses the "Assisstant" font instead of the Volto default "Poppins". You can use Semantic UI variables for customizing the font, as it's a valuable feature.
[plone.org](plone.org) uses the "Assistant" font instead of the Volto default "Poppins". You can use Semantic UI variables for customizing the font, as it's a valuable feature.

Create a file called `site.variables`in the following path `src/addons/<your-addon-name>/theme/globals/`.

Expand All @@ -38,13 +38,13 @@ Everytime you add a new file to your project you will have to restart your devel
Edit the new file and add this:

```less
@fontName: "Asisstant";
@fontName: "Assistant";
```

You can set it to any Google font available, and the online version of the font will be used.
You can also set other variables concerning the font used, such as the sizes available.
In case you want to use more than one font or a font that is self-hosted,
you should define it as usual in CSS and set the variable `importGoogleFonts` appropriately. As `Assisstant` is Google Font we will set:
you should define it as usual in CSS and set the variable `importGoogleFonts` appropriately. As `Assistant` is a Google Font we will set:

```less
@importGoogleFonts: true;
Expand All @@ -56,7 +56,8 @@ Two more important variables that are changed in plone.org are:
@largeMonitorBreakpoint: 1330px;
@emSize: 16px;
```
This changes the width of the default container. Add them as well.
These two variables change the width of the default container.
Add them as well.


```{tip}
Expand Down

0 comments on commit 772c94c

Please sign in to comment.