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

fix typos, make markdownlint happy #201

Merged
merged 1 commit into from
Jul 11, 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
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased](https://github.com/zjedi/hugo-scroll/compare/v.1.0.0...master)

* **JS cleanup / CSS refactoring**, possibly causing some pain if you have extensive CSS customisations in screen.css #4, #61, #102. For backwards compatibility, a released tag` v1.0.0` was created just in case some projects needed to fix the legacy version. However, I won't actively support the legacy branch.
* **JS cleanup / CSS refactoring**, possibly causing some pain if you have extensive CSS customisations in screen.css #4, #61, #102. For backwards compatibility, a released tag `v1.0.0` was created just in case some projects needed to fix the legacy version. However, I won't actively support the legacy branch.
* New features: #70 , #46 , #118
* More features #116 , #119

Expand Down
4 changes: 2 additions & 2 deletions assets/css/variables.scss
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
/* Used for Landing screen menu buttons, but potentially usable for highlighting other things */
--highlight: #86c440;
--highlight-contrast: var(--cover-text-color);
/*iverse colors used for :hover */
/*inverse colors used for :hover */
--highlight-inverse: var(--cover-text-color);
--highlight-inverse-contrast: white;

Expand All @@ -29,7 +29,7 @@
/* Dark section - background color */
--section-dark-bg-color: #b80135;

/* Light&Dark section >quote. Supressive color, compared to 'Light section - text color'*/
/* Light&Dark section >quote. Suppressive color, compared to 'Light section - text color'*/
--section-uni-quote: grey;
/* Light&Dark section `code` a bit darker than 'Light section - background color' */
--section-uni-code-bg-color: #e0ded7;
Expand Down
2 changes: 1 addition & 1 deletion exampleSite/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ enableEmoji = true
# url = ""
# icon = ""

# Define additіonal languages
# Define additional languages
[languages]
[languages.en]
weight = 10
Expand Down
4 changes: 3 additions & 1 deletion exampleSite/content/de/homepage/about-me-local-img.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ This demonstates localized content placed in dedicated language folder, `content
See i18n configuration in `[languages]` section of `config.toml`.

#### Local content

Localised content can be put in dedicated folder `content/de/`. Images should be naturally found from there:
![Image from content/de ](de-happy-ethnic-woman-sitting-at-table-with-laptop-3769021.jpg)

#### Assets

Images in assets folder can be localised, conventionally by adding `.de` suffix. However, assets may be tricky, see next section for details
![Broken DE Image from assets](images/asset-happy-ethnic-woman-sitting-at-table-with-laptop-3769021.de.jpg)

Note the filename of this section is a bit artificial to avoid conflict with other examples in en folder. If named the same, this one wouldn't render. However normally you wouldn't have one page localized two ways.
Note the filename of this section is a bit artificial to avoid conflict with other examples in en folder. If named the same, this one wouldn't render. However normally you wouldn't have one page localized two ways.
9 changes: 6 additions & 3 deletions exampleSite/content/en/homepage/about-me.de.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,26 @@ header_menu: true
This demonstates localized variants `about-me.de.md` placed along the primary language content, such as `content/en`. Both localisation approaches (separate folder, suffixes in the same folder) can be used and mixed.

#### Local content
When localised page variants are placed along, images of other languages can't be used directly. You would need to use `.de`-suffixed copy of the image: `![Jane Doe](en-happy-ethnic-woman-sitting-at-table-with-laptop-3769021.de.jpg)`

When localised page variants are placed along, images of other languages can't be used directly. You would need to use `.de`-suffixed copy of the image: `![Jane Doe](en-happy-ethnic-woman-sitting-at-table-with-laptop-3769021.de.jpg)`
Consider using assets instead.

Images from local content location can't be pipeline-processed.
Images from local content location can't be pipeline-processed.

#### Static

Alternatively, images can be injected from `static/images`:
![Jane Doe](/images/static-happy-ethnic-woman-sitting-at-table-with-laptop-3769021.jpg)
Note the leading `/` is required in this case.
Images from static location can't be pipeline-processed and are always copied when publishing the site, even if not linked from any page.

#### Assets

Latest Hugo version supports injection from `assets` via natural Markdown notation, which empowers this approach for injecting images since pipeline processing (resizing etc) can be used. However, It only worked for me with the local test deployment, there were issues while deploying previews Netlify. Possible workaround would be to use custom shortcode to "touch" the image via [Resources.GetMatch](https://gohugo.io/functions/resources/getmatch/). I hope this gets fixed someday.

![Broken image from assets](images/asset-happy-ethnic-woman-sitting-at-table-with-laptop-3769021.jpg)
Historically, Linking image from `assets` folder worked only via Hugo-specific shortcode, there was [a discussion with suggestions](https://discourse.gohugo.io/t/how-to-show-images-on-post-pages-if-theyre-located-in-the-assets-folder/34276/14).

Note that using images form assets folder is the only way to apply pipeline processing, such as resizing, when building the site. Fore more details, read about [asset vs static difference](https://discourse.gohugo.io/t/difference-between-asset-and-static-folder/41203)

Assets are only published if linked from a content page.
Assets are only published if linked from a content page.
4 changes: 2 additions & 2 deletions exampleSite/content/en/homepage/about-me.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Neither embedded figure shortcode, nor Markdown hook were able to render image f
You would have to .Resouces.GetMatch via custom shortcode.
![Jane Doe](/images/asset-happy-ethnic-woman-sitting-at-table-with-laptop-3769021.jpg)
-->
![Jane Doe](/images/static-happy-ethnic-woman-sitting-at-table-with-laptop-3769021.jpg)
![Jane Doe](/images/static-happy-ethnic-woman-sitting-at-table-with-laptop-3769021.jpg)
See DE language for more examples of image management. There are multiple approaches.

##### Professional Experience
Expand All @@ -18,4 +18,4 @@ A lot, but let us get into the details with some lorem ipsum. Lorem ipsum dolor

----

In ultrices, est at lobortis pretium, magna quam mollis neque, id viverra odio est sit amet lorem. Mauris efficitur nunc vel lectus porttitor, sit amet sodales quam eleifend. Duis et felis ut mauris dignissim efficitur. Aliquam non sem eros. Integer elit ante, bibendum id hendrerit vitae, vestibulum eget risus. Nunc efficitur nisl in iaculis vestibulum.
In ultrices, est at lobortis pretium, magna quam mollis neque, id viverra odio est sit amet lorem. Mauris efficitur nunc vel lectus porttitor, sit amet sodales quam eleifend. Duis et felis ut mauris dignissim efficitur. Aliquam non sem eros. Integer elit ante, bibendum id hendrerit vitae, vestibulum eget risus. Nunc efficitur nisl in iaculis vestibulum.
2 changes: 1 addition & 1 deletion exampleSite/content/en/homepage/legal-brief.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ If the parameter `detailed_page_homepage_content` is set to false neither this s

If `detailed_page_homepage_content` is set to true or is missing at all, the link, navigation menu and the content will be rendered. In that case this section might contain less or just summarized information compared to the single page referenced by the parameter `detailed_page_path`.

Want to see more about the details? See [dedicated page](legal) with more details or hit the button 'Legal' on the cover page.
Want to see more about the details? See [dedicated page](legal) with more details or hit the button 'Legal' on the cover page.