{"id":23197209,"url":"https://github.com/jsnjack/kraiklyn","last_synced_at":"2025-08-29T16:20:22.639Z","repository":{"id":48307650,"uuid":"119292750","full_name":"jsnjack/kraiklyn","owner":"jsnjack","description":"A Hugo theme for one page documentation","archived":false,"fork":false,"pushed_at":"2025-06-30T15:54:20.000Z","size":178,"stargazers_count":51,"open_issues_count":3,"forks_count":35,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-08-18T22:42:30.331Z","etag":null,"topics":["documentation","hugo","hugo-theme","single-page-site","theme"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jsnjack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-01-28T19:59:39.000Z","updated_at":"2025-07-21T06:23:23.000Z","dependencies_parsed_at":"2025-08-18T22:33:03.034Z","dependency_job_id":"568eec51-1153-4219-b9c7-34d14f2e4d08","html_url":"https://github.com/jsnjack/kraiklyn","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jsnjack/kraiklyn","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsnjack%2Fkraiklyn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsnjack%2Fkraiklyn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsnjack%2Fkraiklyn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsnjack%2Fkraiklyn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsnjack","download_url":"https://codeload.github.com/jsnjack/kraiklyn/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsnjack%2Fkraiklyn/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272717973,"owners_count":24981487,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-29T02:00:10.610Z","response_time":87,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","hugo","hugo-theme","single-page-site","theme"],"created_at":"2024-12-18T14:29:08.828Z","updated_at":"2025-08-29T16:20:22.611Z","avatar_url":"https://github.com/jsnjack.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"Kraiklyn\n=====\n\nA simple one page [Hugo](https://gohugo.io/) theme for documentation. Inspired by Hyde, Simpledoc and docDock themes\n\n# Features\n - all content is rendered on one page\n - unlimited menu level\n - mobile friendly\n - customize website logo\n - add links to the sidebar\n\n# Installation\nClone the repository to your site’s themes directory.\n\n# Usage\nAll content is rendered on the main page. Front-matter's `anchor` is used for the navigation. Content is ordered by Weight.\n\nWhen creating a new section, make sure `_index.md` exists for correct cross-references.\n\n## Shortcodes\n\n### block\nCreate notes, tips and other blocks on the page\n```markdown\n{{\u003c block note \u003e}}\nBy default only ports 22, 80 and 443 are open\n{{\u003c /block \u003e}}\n```\nAvailable types: `note`, `tip`, `warn`, `info`\n\n### readfile\nReads a file and displays its contents, skipping the specified section.\n```markdown\n{{\u003c readfile file=\"path/to/file\" skip-to=\"section\" lang=\"ini\" \u003e}}\n```\n\n### anchor\nReturns `anchor` parameter (see `archetypes/default.md` file) of the article\n```markdown\nCheck [Proxy environment]({{\u003c anchor \"installation/proxy-environment.md\" \u003e}}) section\n```\nSince the theme is a one-page theme, this is the way to make cross-references on the website\n\n## Customizing sidebar\n\n### Changing logo\nReplace logo by creating `layouts/partials/logo.html` file\n\n### Adding menu entries to the external links section\nCustomize the name of the section by adding to the `config.toml`\n```toml\n[params]\nexternalTitle = \"Surfly docs\"\n```\n\nAdd new entries:\n```toml\n[[menu.shortcuts]]\nname = \"Javascript API\"\nurl = \"https://docs.surfly.com/javascript.html\"\nweight = 20\n```\n\n### Changing color\nCustomize the color of the sidebar by adding to the `config.toml`\n```toml\n[params]\nsidebarColor = \"green\"\n```\n\nAvailable values : default, green, purple, pink, red, cyan, blue, grey, orange.\n\n## Add favicon\nPut `favicon.ico` inside `static` folder\n\n\n## Add custom CSS\nYou can add your custom CSS files with the `customCss` parameter of the configuration file.\n\n```toml\ncustomCss = [\"css/custom.css\", \"css/custom2.css\"]\n```\n\nJust put your files in `static/css` directory.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsnjack%2Fkraiklyn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsnjack%2Fkraiklyn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsnjack%2Fkraiklyn/lists"}