Skip to content

Commit

Permalink
Merge pull request #18077 from ckeditor/ck/bookmarksfollowup
Browse files Browse the repository at this point in the history
Docs: updating bookmarks and links guides.
  • Loading branch information
godai78 authored Mar 7, 2025
2 parents 88b15d8 + ed3947e commit 499eaec
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ <h2>
PUBLISHING AGREEMENT
</h2>
<h3>
Introduction
<a id="Introduction"></a>Introduction
</h3>
<p>
This publishing contract, the “contract”, is entered into as of 1st June 2020 by and between The Lower Shelf, the “Publisher”, and John Smith, the “Author”.
Expand Down
10 changes: 2 additions & 8 deletions packages/ckeditor5-bookmark/docs/features/bookmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,9 @@ The bookmarks feature allows for adding and managing the bookmarks anchors attac

## Demo

Use the bookmark toolbar button {@icon @ckeditor/ckeditor5-icons/theme/icons/bookmark.svg Add bookmark} in the editor below to see the feature in action. Or use the "Insert" command from the menu bar to add a bookmark. Add a unique name to identify the bookmark (for example, `Rights`).
Use the bookmark toolbar button {@icon @ckeditor/ckeditor5-icons/theme/icons/bookmark.svg Add bookmark} in the editor below to see the feature in action. Or use the "Insert" command from the menu bar to add a bookmark. Add a unique name to identify the bookmark (for example, `Rights`). You can change the bookmark's name or remove it by clicking the bookmark icon inside the content.

To use the bookmark as an anchor in the content, add a link {@icon @ckeditor/ckeditor5-icons/theme/icons/link.svg Add link} and put the bookmark name as target. In the example below it would be `#Rights`. You can change the bookmark's name or remove it by clicking the bookmark icon inside the content. A contextual bookmark toolbar will pop up.

<info-box info>
The Bookmarks feature is production-ready but does not include integration with the linking experience yet (see [#17230](https://github.com/ckeditor/ckeditor5/issues/17230)).

Integrators should guide their users on linking to bookmarks using the `#` anchors.
</info-box>
To use the bookmark as an anchor in the content, add a link {@icon @ckeditor/ckeditor5-icons/theme/icons/link.svg Add link} and put the bookmark name as target. In the example below it could be `#Rights`. The link insertion panel will display all bookmarks available in the edited content (see the [Integration with the link feature](#integration-with-the-link-feature) section below).

{@snippet features/bookmark}

Expand Down
5 changes: 4 additions & 1 deletion packages/ckeditor5-link/docs/_snippets/features/link.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ <h3>Valletta</h3>
masterpieces, delicious local cuisine, and at least 8 months of sun.
</p>
<p>
It’s also a top destination for filmmakers so that you can take a tour through locations familiar
It’s also a top destination for <a id="Movies"></a>filmmakers so that you can take a tour through locations familiar
to you from <a href="https://en.wikipedia.org/wiki/Game_of_Thrones">Game
of Thrones</a>, <a href="https://en.wikipedia.org/wiki/Gladiator_(2000_film)">Gladiator</a>,
<a href="https://en.wikipedia.org/wiki/Troy_(film)">Troy</a>, and many more.
</p>
<p>
The city was officially recognised as a <a id="Heritage"></a>World Heritage Site by <a href="https://en.wikipedia.org/wiki/UNESCO">UNESCO</a> in 1980. The city has 320 monuments, all within an area of 0.55 square kilometres (0.21 sq mi), making it one of the most concentrated historic areas in the world. Sometimes called an "open-air museum", Valletta was chosen as the European Capital of Culture in 2018. Valletta was also listed as the sunniest city in Europe in 2016.
</p>
</div>

0 comments on commit 499eaec

Please sign in to comment.