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

Using local clone of docsy theme (via hugo workspace) #194

Merged
merged 1 commit into from
Nov 10, 2023

Conversation

deining
Copy link
Collaborator

@deining deining commented Dec 28, 2022

This PR adds a hugo workspace file to the repo, pointing to the local git submodule clone of the docsy theme.
This way, local edits to the theme can be immediately picked up when previewing the site. This facilitates hacking the docsy theme. A section Hacking docsy theme was added to README.md, describing the details of local edits while using a hugo workspace file.

@deining
Copy link
Collaborator Author

deining commented Jun 29, 2023

Reworked the PR, it now corresponds to HEAD of repo again. Additionally, I added support for local builds via npm, as proposed in #227.

Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comments, thanks.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
hugo.toml Outdated Show resolved Hide resolved
hugo.work Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
hugo.work Outdated Show resolved Hide resolved
hugo.work Outdated Show resolved Hide resolved
@chalin
Copy link
Collaborator

chalin commented Nov 9, 2023

Would the following NPM script work under Windows?

    "test": "echo ${HI:-Hello}",

@deining
Copy link
Collaborator Author

deining commented Nov 9, 2023

Would the following NPM script work under Windows?

    "test": "echo ${HI:-Hello}",

I don't have a Windows machine at hand right now. Will check tomorrow at work.

Support of local builds, using docsy theme in a sibling folder
@deining
Copy link
Collaborator Author

deining commented Nov 9, 2023

See inline comments, thanks.

Thanks for your comments, all raised topics are resolved now.

@deining
Copy link
Collaborator Author

deining commented Nov 10, 2023

Would the following NPM script work under Windows?

    "test": "echo ${HI:-Hello}",

No, unfortunately not:

Windows

$ npm run test

> docsy-example-site@0.7.1 test2
> echo ${HI:-Hello}

${HI:-Hello}

Linux

$ npm run test

> docsy-example-site@0.7.1 test2
> echo ${HI:-Hello}

Hello

@deining
Copy link
Collaborator Author

deining commented Nov 10, 2023

Would the following NPM script work under Windows?

    "test": "echo ${HI:-Hello}",

Not fully clear what you are targeting at, but could the use of this package be a solution?
I remember issue #973 which adresses a related problem.

@chalin
Copy link
Collaborator

chalin commented Nov 10, 2023

Not fully clear what you are targeting at, but could the use of this package be a solution? I remember issue #973 which adresses a related problem.

I'm trying to avoid introducing dependencies for contributors. I don't have a solution that I'm 100% happy with yet (which is why I haven't addressed #973) -- I'm looking for a solution that I can adopt across all of my projects. Cross-env might be the answer.

Thanks for testing out the ${HI:-Hello} syntax and letting me know about shelljs.

@chalin chalin merged commit b02b0be into google:main Nov 10, 2023
5 checks passed
@deining deining changed the title Hacking docsy theme (using hugo workspace) Using local clone of docsy theme (via hugo workspace) Nov 10, 2023
@deining deining deleted the hugo_workspace branch November 10, 2023 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants