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.

Sign up for GitHub

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

Jump to bottom

CHANGELOG: mention new docsy-as-NPM-package option #1125

Merged
merged 2 commits into from
Jul 27, 2022
Merged

CHANGELOG: mention new docsy-as-NPM-package option #1125

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98bba27
CHANGELOG: add docsy-as-NPM-package
chalin Jul 27, 2022
023f447
Run markdown prettifier
chalin Jul 27, 2022
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
51 changes: 30 additions & 21 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,17 @@ For a list of issues targeted for the next release, see the [22Q2][] milestone.

For a full list of the changes to this release, see the [release notes][0.5.0].

**New**:

- Projects can now install and use [Docsy as an NPM package][].

**Breaking changes**:

- ...

[docsy as an npm package]:
https://www.docsy.dev/docs/get-started/other-options/#option-3-docsy-as-an-npm-package

## [0.4.0][]

For a full list of the changes to this release, see the [release notes][0.4.0].
Expand All @@ -25,62 +32,64 @@ For a full list of the changes to this release, see the [release notes][0.4.0].
and FontAwesome. Migrate your site by following these steps (execute commands
from your project's root directory):

1. Update Docsy to 0.4.0.
2. Delete obsolete Docsy Git submodules:
1. Update Docsy to 0.4.0.
2. Delete obsolete Docsy Git submodules:
```console
$ rm -Rf themes/docsy/assets/vendor
```
3. Get Docsy dependencies:
3. Get Docsy dependencies:
```console
$ (cd themes/docsy && npm install)
```
4. (Optional) If your site project uses NPM, consider getting Docsy
dependencies via a `prepare` script, for example:
4. (Optional) If your site uses NPM, consider getting Docsy dependencies via
a [prepare][] script as follows:
```json
{
"name": "my-website",
"scripts": {
"get:submodule": "git submodule update --init --depth 1",
"_prepare:docsy": "cd themes/docsy && npm install",
"prepare": "npm run get:submodule && npm run _prepare:docsy",
"prepare": "cd themes/docsy && npm install",
"...": "..."
},
"...": "..."
}
```
5. Proceed as usual to build or serve your site.
5. Proceed as usual to build or serve your site.

[Hugo Modules]: https://www.docsy.dev/docs/get-started/docsy-as-module/
[other Docsy setups]: https://www.docsy.dev/docs/get-started/other-options/
[hugo modules]: https://www.docsy.dev/docs/get-started/docsy-as-module/
[other docsy setups]: https://www.docsy.dev/docs/get-started/other-options/
[prepare]:
https://docs.npmjs.com/cli/v8/using-npm/scripts#prepare-and-prepublish

## [0.3.0][]

For a full list of the changes to this release, see the [release notes][0.3.0].

**Breaking changes**:

- Upgrade to [Algolia DocSearch
v3](https://docsearch.algolia.com/docs/DocSearch-v3). If your site uses the
deprecated DocSearch v2, you must [update your DocSearch
code](https://docsearch.algolia.com/docs/migrating-from-v2).
- Upgrade to
[Algolia DocSearch v3](https://docsearch.algolia.com/docs/DocSearch-v3). If
your site uses the deprecated DocSearch v2, you must
[update your DocSearch code](https://docsearch.algolia.com/docs/migrating-from-v2).

## [0.2.0][]

**New**:

- Add official Docsy support for [Hugo modules][]. Many thanks to the dedicated and
patient efforts of [@deining][], who researched, experimented, and implemented
this feature. Thanks to [@deining][] and [@LisaFC][] for the doc updates.
- Add official Docsy support for [Hugo modules][]. Many thanks to the dedicated
and patient efforts of [@deining][], who researched, experimented, and
implemented this feature. Thanks to [@deining][] and [@LisaFC][] for the doc
updates.

For details, see [Migrate to Hugo Modules](https://www.docsy.dev/docs/updating/convert-site-to-module/).
For details, see
[Migrate to Hugo Modules](https://www.docsy.dev/docs/updating/convert-site-to-module/).

**Details**:

- For a full list of the changes to this release, see the [release notes][0.2.0]

## [0.X.Y][] - next planned release (unpublished yet)

For a full list of the changes to this release, see the [release notes][0.X.Y].
For a full list of the changes to this release, see the [release notes][0.x.y].

**Breaking changes**:

Expand All @@ -92,7 +101,7 @@ For a full list of the changes to this release, see the [release notes][0.X.Y].
[0.3.0]: https://github.com/google/docsy/releases/v0.3.0
[0.4.0]: https://github.com/google/docsy/releases/v0.4.0
[0.5.0]: https://github.com/google/docsy/releases/v0.5.0
[0.X.Y]: #
[0.x.y]: #
[22q2]: https://github.com/google/docsy/milestone/3
[hugo modules]: https://gohugo.io/hugo-modules/
[latest]: https://github.com/google/docsy/releases/latest
Expand Down