Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
156 commits
Select commit Hold shift + click to select a range
1204a2c
Prepare structure that allows to get the documentation files as the H…
JuliaEvseeva Nov 24, 2025
ffbaef6
Install the "Roboto", "PT Serif", and Font Awesome
JuliaEvseeva Nov 25, 2025
ec2fe36
Add the copyright
JuliaEvseeva Nov 25, 2025
80f7e48
Add functions needed for the docs path resolving
JuliaEvseeva Nov 25, 2025
20df4f2
Render images and links with the proper settings
JuliaEvseeva Nov 27, 2025
7e6328f
Add needed configurations to run the site locally
JuliaEvseeva Nov 27, 2025
f475d8e
Add the three column layout
JuliaEvseeva Nov 27, 2025
102e485
Create the three column layout and make the TOC interactive
JuliaEvseeva Nov 27, 2025
d77c708
Create the JS main for docs
JuliaEvseeva Nov 27, 2025
605fd47
Prepare structure for sidenav
JuliaEvseeva Nov 27, 2025
cb46cfd
Clean up sidenav styles
JuliaEvseeva Nov 27, 2025
a0bf77b
Implement the sidenav
JuliaEvseeva Nov 28, 2025
f62f975
Update TOC styles and improve the website preview
JuliaEvseeva Nov 28, 2025
f17cd03
Update the layout
JuliaEvseeva Nov 28, 2025
b2c9155
Implement the `next-prev` bottom navigation
JuliaEvseeva Nov 28, 2025
3323f3f
Open/close sidenav on mobiles
JuliaEvseeva Nov 28, 2025
fd952bd
Clean up styles on mobiles
JuliaEvseeva Nov 28, 2025
e1d306f
Improve the TOC component
JuliaEvseeva Nov 28, 2025
68e8137
Implement the interactive architecture diagram
JuliaEvseeva Nov 28, 2025
47c61c5
Render the "Overview" page in the sidenav
JuliaEvseeva Dec 1, 2025
1aa5ac5
Add the page title
JuliaEvseeva Dec 1, 2025
f3624e0
Fix the font path
JuliaEvseeva Dec 1, 2025
16d04b0
Improve the interactive TOC
JuliaEvseeva Dec 1, 2025
2ca1935
Implement the code blocks
JuliaEvseeva Dec 1, 2025
6b58899
Reorganize components
JuliaEvseeva Dec 1, 2025
338ef38
Clean up layout
JuliaEvseeva Dec 1, 2025
1e8776b
Move icons under `img`
JuliaEvseeva Dec 1, 2025
bf36d5a
Style the toggle theme icon
JuliaEvseeva Dec 1, 2025
5c4a133
Add styles for the note block
JuliaEvseeva Dec 1, 2025
bed4caa
Update position
JuliaEvseeva Dec 1, 2025
2a215f6
Add common fonts, images, and styles
JuliaEvseeva Dec 1, 2025
5864250
Remove code styles for now
JuliaEvseeva Dec 1, 2025
932423c
Merge branch 'hugo-assets' into hugo-theme-setup
JuliaEvseeva Dec 1, 2025
5654793
Clean up one article for testing and add variables
JuliaEvseeva Dec 1, 2025
1f79cfe
Change the theme priority
JuliaEvseeva Dec 2, 2025
ddfb0d7
Add the test config for the next major version
JuliaEvseeva Dec 2, 2025
802ebe0
Clean up link styles
JuliaEvseeva Dec 2, 2025
701e950
Update code block style for the light theme
JuliaEvseeva Dec 2, 2025
d29687c
Add the additional check for the TOC scrolling
JuliaEvseeva Dec 2, 2025
a30f75d
Merge pull request #42 from SpineEventEngine/hugo-assets
JuliaEvseeva Dec 2, 2025
bf2b4fe
Implement the category cards
JuliaEvseeva Dec 2, 2025
3fe17bd
Clean up sidenav styles
JuliaEvseeva Dec 2, 2025
4fc3232
Add shortcodes for resources pages
JuliaEvseeva Dec 2, 2025
453ed63
Add the TOC item `line-height`
JuliaEvseeva Dec 2, 2025
f901f4e
Place the `Full diagram view` link before the diagram
JuliaEvseeva Dec 2, 2025
3670382
Render links inside cards
JuliaEvseeva Dec 2, 2025
8a8a931
Update the sticky element max-height
JuliaEvseeva Dec 2, 2025
af701ca
Add the anchor icons near each title in documentation
JuliaEvseeva Dec 3, 2025
f566768
Clean up the link rendering
JuliaEvseeva Dec 3, 2025
8bc6f98
Make the clickable area bigger for the bottom nav
JuliaEvseeva Dec 3, 2025
8553187
Add a check that the page is exists
JuliaEvseeva Dec 3, 2025
856983c
Remove the additional `div` between text element
JuliaEvseeva Dec 3, 2025
fbc38df
Clean up unused variables
JuliaEvseeva Dec 4, 2025
4c47cbe
Remove the `copy-code` for now
JuliaEvseeva Dec 4, 2025
2a19cdd
Use two types of comments in CSS: silent and loud (for component desc…
JuliaEvseeva Dec 4, 2025
80bbe22
Update URLs to repositories
JuliaEvseeva Dec 4, 2025
6e83ec5
Update variable names correspondingly
JuliaEvseeva Dec 5, 2025
4404bbe
Clean up functions
JuliaEvseeva Dec 8, 2025
b9f8374
Add the Spine favicon
JuliaEvseeva Dec 8, 2025
11f43ab
Change the path
JuliaEvseeva Dec 8, 2025
fde3ff3
Merge pull request #44 from SpineEventEngine/hugo-theme-setup
JuliaEvseeva Dec 9, 2025
66302e3
Add Hugo files.
MykytaPimonovTD Dec 9, 2025
62414e1
Merge pull request #45 from SpineEventEngine/hugo-favicon
JuliaEvseeva Dec 9, 2025
9e31243
Configure inner link param.
MykytaPimonovTD Dec 9, 2025
7526138
Rename one arg.
MykytaPimonovTD Dec 9, 2025
8ef712a
Improve relative links.
MykytaPimonovTD Dec 9, 2025
36b9d96
Move files to `_hugo_theme`.
MykytaPimonovTD Dec 9, 2025
c4edb8d
Merge branch 'migration-to-hugo' into migrate-documentation-to-hugo
MykytaPimonovTD Dec 9, 2025
1abe338
Rollback index file.
MykytaPimonovTD Dec 9, 2025
857b232
Use variable instead of `https://github.com/spine-examples`.
MykytaPimonovTD Dec 9, 2025
44b4afd
Delete redundant line in note-block.
MykytaPimonovTD Dec 9, 2025
6a1d726
Use the markdown syntax instead of the HTML
JuliaEvseeva Dec 9, 2025
bab6185
Add images needed for Docs
JuliaEvseeva Dec 9, 2025
b274d28
Delete `next_btn` frontmatter param.
MykytaPimonovTD Dec 9, 2025
a04ae37
Fix note-blocks.
MykytaPimonovTD Dec 9, 2025
7e66fb4
Simplify link to images.
MykytaPimonovTD Dec 9, 2025
5a5830e
Add a shortcode for the image caption
JuliaEvseeva Dec 9, 2025
d3a6a7b
Merge branch 'migrate-documentation-to-hugo' into add-images
JuliaEvseeva Dec 9, 2025
c99e8f2
Add the code languages
JuliaEvseeva Dec 9, 2025
953180b
Merge branch 'migrate-documentation-to-hugo' into add-images
JuliaEvseeva Dec 9, 2025
0ae6f79
Fix links in var definitions.
MykytaPimonovTD Dec 9, 2025
96cb7ae
Clean up
JuliaEvseeva Dec 9, 2025
d1a8d0d
Add code languages to Jekyll
JuliaEvseeva Dec 9, 2025
c745244
Merge remote-tracking branch 'origin/migrate-documentation-to-hugo' i…
JuliaEvseeva Dec 9, 2025
3416f16
Merge pull request #46 from SpineEventEngine/migrate-documentation-to…
MykytaPimonovTD Dec 9, 2025
5225814
Clean up docs and styles
JuliaEvseeva Dec 9, 2025
98d0663
Change Twitter links to X
JuliaEvseeva Dec 9, 2025
4a505b2
Merge branch 'migration-to-hugo' into add-images
JuliaEvseeva Dec 9, 2025
c192d37
Avoid the empty line rendering
JuliaEvseeva Dec 10, 2025
b9ddec4
Add EOF to every file
JuliaEvseeva Dec 10, 2025
dbade2b
Clean up style
JuliaEvseeva Dec 10, 2025
011600c
Remove the unused styles in favor of the `note-block`
JuliaEvseeva Dec 10, 2025
78d56a5
Clean up styles
JuliaEvseeva Dec 10, 2025
7cb00ef
Use markdown syntax
JuliaEvseeva Dec 10, 2025
e87a975
Align TOC and sidenav
JuliaEvseeva Dec 10, 2025
22a8b1f
Merge pull request #47 from SpineEventEngine/add-images
JuliaEvseeva Dec 10, 2025
8985a16
Remove the sidebar and TOC top padding to scroll the elements under t…
JuliaEvseeva Dec 10, 2025
357ec3e
Use the navbar height
JuliaEvseeva Dec 10, 2025
6a99d2a
Remove extra content margin
JuliaEvseeva Dec 10, 2025
bc9f4c9
Clean up
JuliaEvseeva Dec 11, 2025
c767e43
Merge pull request #48 from SpineEventEngine/improve-sidebar-and-toc
JuliaEvseeva Dec 11, 2025
6dfbc6c
Update submodules
JuliaEvseeva Dec 11, 2025
ec5997a
Add the `embed-code` configuration
JuliaEvseeva Dec 11, 2025
0c98a85
Get the latest updates from the examples
JuliaEvseeva Dec 11, 2025
62eaaaa
Improve the guide
JuliaEvseeva Dec 11, 2025
0ef594a
Clean up
JuliaEvseeva Dec 11, 2025
a4f475c
Revert the indentation
JuliaEvseeva Dec 11, 2025
0f623fd
Add spaces to get the proper code fragment
JuliaEvseeva Dec 11, 2025
f1395ac
Remove unused mixins and duplicated breakpoint variables
JuliaEvseeva Dec 11, 2025
29d5b01
Add a class for Resources pages
JuliaEvseeva Dec 11, 2025
e0cf292
Merge pull request #49 from SpineEventEngine/hugo-embed-code
JuliaEvseeva Dec 11, 2025
b95a963
Remove the `nbsp` from title
JuliaEvseeva Dec 11, 2025
315d55c
Add the `min-max` breakpoint
JuliaEvseeva Dec 11, 2025
8234473
Remove empty spaces
JuliaEvseeva Dec 11, 2025
9eae52b
Add the common tooltip styles
JuliaEvseeva Dec 12, 2025
d50cd0b
Improve the code theme colors
JuliaEvseeva Dec 12, 2025
8d8398b
Merge branch 'migration-to-hugo' into update-readme
JuliaEvseeva Dec 12, 2025
d5eceb9
Update the `README.md` to run the website on Hugo
JuliaEvseeva Dec 12, 2025
736dc5a
Use the new `build` option instead of the deprecated `_build`
JuliaEvseeva Dec 12, 2025
816b832
Disable taxonomies and terms
JuliaEvseeva Dec 12, 2025
83679f0
Merge pull request #50 from SpineEventEngine/hugo-style-cleanup
JuliaEvseeva Dec 12, 2025
8cd6939
Add a guide for the major documentation release
JuliaEvseeva Dec 12, 2025
7670a96
Clean up
JuliaEvseeva Dec 12, 2025
8e6a7b5
Merge branch 'migration-to-hugo' into update-readme
JuliaEvseeva Dec 12, 2025
d68f2d2
Delete the Jekyll website and move `_hugo-theme` to `docs` and `_hugo…
JuliaEvseeva Dec 15, 2025
9625fe5
Update path to the documentation
JuliaEvseeva Dec 15, 2025
0822e88
Rename module names
JuliaEvseeva Dec 15, 2025
8a4bbba
Merge pull request #52 from SpineEventEngine/delete-jekyll
JuliaEvseeva Dec 15, 2025
4978171
Merge branch 'migration-to-hugo' into update-readme
JuliaEvseeva Dec 15, 2025
9ecd620
Update the folder names
JuliaEvseeva Dec 15, 2025
fcb7c0c
Fix typo in URL
JuliaEvseeva Dec 15, 2025
e6ce642
Fix the URL
JuliaEvseeva Dec 15, 2025
d1da958
Make it possible to provide the optional `is_active` property from th…
JuliaEvseeva Dec 16, 2025
1a04fa8
Clean up
JuliaEvseeva Dec 16, 2025
079d45f
Merge pull request #51 from SpineEventEngine/update-readme
JuliaEvseeva Dec 16, 2025
a553bc7
Add the local Java version to `gitignore`
JuliaEvseeva Dec 16, 2025
83509c3
Configure gradle to be able to build code samples, embed, and check them
JuliaEvseeva Dec 16, 2025
3728967
Run action on PR
JuliaEvseeva Dec 16, 2025
5d12a35
Use the appropriate Java version
JuliaEvseeva Dec 16, 2025
448f3d9
Use the `macos-latest` to be able to run the binary
JuliaEvseeva Dec 16, 2025
4b93e48
Update the documentation
JuliaEvseeva Dec 16, 2025
d3d265b
Disable the code check until the issue with code alignment will be fixed
JuliaEvseeva Dec 16, 2025
2f9dd10
Update the `README.md`
JuliaEvseeva Dec 16, 2025
8e6b9c6
Add `samples` and include them to the build
JuliaEvseeva Dec 16, 2025
0be11e6
Improve the `EMBEDDING` guide
JuliaEvseeva Dec 16, 2025
067262a
Update `README`
JuliaEvseeva Dec 16, 2025
d74bbc0
Add gradle build folders to ignore
JuliaEvseeva Dec 16, 2025
512e49c
Try to use `ubuntu` binary for GH Action
JuliaEvseeva Dec 16, 2025
aa7ad3c
Add permissions to the binary
JuliaEvseeva Dec 16, 2025
087d9b7
Disable the `embedded-samples` check until the issue with alignment w…
JuliaEvseeva Dec 16, 2025
b3dfec8
Improve comment
JuliaEvseeva Dec 17, 2025
3570a0b
Merge pull request #53 from SpineEventEngine/check-samples
JuliaEvseeva Dec 17, 2025
ad14047
Add information about the embed-code
JuliaEvseeva Dec 17, 2025
8184602
Merge branch 'master' into migration-to-hugo
JuliaEvseeva Dec 17, 2025
6518b19
Clean up theme styles
JuliaEvseeva Dec 17, 2025
16be425
Clean up
JuliaEvseeva Dec 17, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
37 changes: 37 additions & 0 deletions .github/workflows/check-code-embedding.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Check Code Embedding

on:
pull_request:

jobs:
build-embedded-code:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
with:
submodules: 'recursive'

- uses: actions/setup-java@v5
with:
java-version: 8
distribution: zulu

- run: ./gradlew :buildAll

check-embedded-samples:
# TODO:2025-12-16:julia.evseeva: Remove the `if: false` when the issue
# will be fixed https://github.com/SpineEventEngine/embed-code/issues/66
if: false
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
with:
submodules: 'recursive'

- uses: actions/setup-java@v5
with:
java-version: 11
distribution: zulu

- name: Check Embedding
run: ./gradlew :checkSamples
33 changes: 27 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
# The result of Jekyll build
_site
.sass-cache
.jekyll-metadata
# Hugo cache files
/site/resources
public

# Intermediate directory used by `embed-code` Jekyll subcommand
.fragments
# Cache folder for Hugo Modules
/site/_vendor

# Node modules
node_modules

# Used to control concurrency between multiple Hugo instances
/site/.hugo_build.lock

# Needed for navigation/intellisense help inside code editors
jsconfig.json

# IntelliJ IDEA modules and interim config files
*.iml
Expand All @@ -18,3 +26,16 @@ _site
!.idea/misc.xml
!.idea/codeStyles/
!.idea/copyright/

# The `embed-code` temporary directory
_code/build

# Local Java version for this project
.java-version

# Gradle interim configs
.gradle/

# Gradle build files
build/
generated/
7 changes: 7 additions & 0 deletions .idea/copyright/profiles_settings.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 0 additions & 24 deletions 404.html

This file was deleted.

9 changes: 0 additions & 9 deletions Gemfile

This file was deleted.

Loading