{"id":23070252,"url":"https://github.com/markbattistella/docsify-sidebar-footer","last_synced_at":"2026-02-17T02:31:50.163Z","repository":{"id":56687594,"uuid":"288163901","full_name":"markbattistella/docsify-sidebar-footer","owner":"markbattistella","description":"Add some info at the bottom of your sidebar. Link to your personal website, a Privacy Policy, Terms of Service","archived":false,"fork":false,"pushed_at":"2023-05-22T04:31:58.000Z","size":194,"stargazers_count":9,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-19T19:23:38.710Z","etag":null,"topics":["cookie","docsify","docsify-plugin","footer","plugin","privacy","tos"],"latest_commit_sha":null,"homepage":"https://footer.docsify.markbattistella.com","language":null,"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/markbattistella.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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},"funding":{"github":["markbattistella"],"custom":["https://www.paypal.me/markbattistella/5AUD","https://www.paypal.me/markbattistella/10AUD","https://www.paypal.me/markbattistella/20AUD"]}},"created_at":"2020-08-17T11:37:34.000Z","updated_at":"2024-02-19T20:32:26.000Z","dependencies_parsed_at":"2024-12-16T06:37:47.472Z","dependency_job_id":null,"html_url":"https://github.com/markbattistella/docsify-sidebar-footer","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markbattistella%2Fdocsify-sidebar-footer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markbattistella%2Fdocsify-sidebar-footer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markbattistella%2Fdocsify-sidebar-footer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markbattistella%2Fdocsify-sidebar-footer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markbattistella","download_url":"https://codeload.github.com/markbattistella/docsify-sidebar-footer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246981167,"owners_count":20863828,"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","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":["cookie","docsify","docsify-plugin","footer","plugin","privacy","tos"],"created_at":"2024-12-16T06:25:28.794Z","updated_at":"2025-10-13T08:18:31.456Z","avatar_url":"https://github.com/markbattistella.png","language":null,"funding_links":["https://github.com/sponsors/markbattistella","https://www.paypal.me/markbattistella/5AUD","https://www.paypal.me/markbattistella/10AUD","https://www.paypal.me/markbattistella/20AUD"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# docsify.js sidebar footer\n\n\u003c/div\u003e\n\nThis plugin enhances your website's sidebar or page by creating a footer area where you can display important information. It automatically updates the copyright year or range, allows you to include your name or company with a URL, and provides links to a privacy policy, terms of service, and cookies policy pages. By utilising this plugin, you can easily showcase relevant legal information, personalise your website, and promote transparency and compliance.\n\n## Installation\n\n!\u003e **Note: There are breaking changes in the configuration from `v4.x` to `v5.x`. Please take the time to read all the documentation before upgrading**\n\n### Update `index.html` file\n\nAssuming you have a working [docsify](https://docsify.js.org/) framework set up, it is easy to use the plugin.\n\n1. Add one of the following script tags to your `index.html` via either CDN or downloading it and using it locally:\n\n    ```html\n    \u003c!-- unpkg.com --\u003e\n    \u003cscript src=\"https://unpkg.com/@markbattistella/docsify-sidebarfooter@latest\"\u003e\u003c/script\u003e\n\n    \u003c!-- jsDelivr --\u003e\n    \u003cscript src=\"https://cdn.jsdelivr.net/npm/@markbattistella/docsify-sidebarfooter@latest\"\u003e\u003c/script\u003e\n\n    \u003c!-- locally --\u003e\n    \u003cscript src=\"docsify-sidebar.min.js\"\u003e\u003c/script\u003e\n    ```\n\n1. In docsify setup configure the plugin:\n\n    ```js\n    \u003cscript\u003e\n    window.$docsify = {\n      autoFooter: {\n\n        // the name you wish to display as the copyright holder\n        name:        String,\n\n        // the URL (personal or company) which clicking the `name` goes to\n        url:         String,\n\n        // the start year of copyright\n        copyYear:    String,\n\n        // show the privacy policy link\n        policy:      Bool | String,\n\n        // show the terms of service link\n        terms:       Bool | String,\n\n        // show the cookies policy link\n        cookies:     Bool | String,\n\n        // use your own css styles or the built in ones\n        customStyle: Bool | String\n      }\n    };\n    \u003c/script\u003e\n    ```\n\n### Additional files\n\n#### Default\n\nIf you set the `policy`, `terms`, or `cookies` options to `true` the URL links for those pages will look for the markdown files directly next to the `index.html` file:\n\n```js\n// ... other config\npolicy: true,\nterms: true,\ncookies: true,\n// ... other config\n```\n\n```md\n- index.html      --\u003e https://your-awesome-site.com/#/\n- _policy.md      --\u003e https://your-awesome-site.com/#/_policy\n- _terms.md       --\u003e https://your-awesome-site.com/#/_terms\n- _cookies.md     --\u003e https://your-awesome-site.com/#/_cookies\n```\n\n#### Sub-folder\n\nHowever, if you enter a string it will append that to the base URL of your website:\n\n```js\n// ... other config\npolicy: 'site/policy',\nterms: 'site/terms',\ncookies: 'site/cookies',\n// ... other config\n```\n\n```md\n- index.html      --\u003e https://your-awesome-site.com/#/\n- site/\n  \\__ policy.md   --\u003e https://your-awesome-site.com/#/site/policy\n  \\__ terms.md    --\u003e https://your-awesome-site.com/#/site/terms\n  \\__ cookies.md  --\u003e https://your-awesome-site.com/#/site/cookies\n```\n\n#### External links\n\nIf you host your policy, terms, or cookies messages on an external website (or need to link to a parent company policy) you can add them in as the full URL:\n\n```js\n// ... other config\npolicy: \"https://my-other-website.com/policy\",\nterms: \"https://my-other-website.com/terms\",\ncookies: \"https://my-other-website.com/cookies\",\n// ... other config\n```\n\nThese will open those pages in a new tab directly.\n\n## Configuration\n\nThere are some options available for the `docsify-sidebarfooter`:\n\n| Setting       | Type           | Options                            |\n|---------------|----------------|------------------------------------|\n| `name`        | String         | your name or company               |\n| `url`         | String         | url you want the `name` to link to |\n| `copyYear`    | String         | first year of copyright            |\n| `policy`      | Bool or String | - `false` hides it from the site\u003cbr/\u003e- `true` defaults to `_policy.md`\u003cbr/\u003e- a custom string will direct to that |\n| `terms`       | Bool or String | - `false` hides it from the site\u003cbr/\u003e- `true` defaults to `_terms.md`\u003cbr/\u003e- a custom string will direct to that |\n| `cookies`     | Bool or String | - `false` hides it from the site\u003cbr/\u003e- `true` defaults to `_cookies.md`\u003cbr/\u003e- a custom string will direct to that |\n| `customStyle` | Bool or String | - `false` uses in-built css (sidebar styled)\u003cbr/\u003e- `true` applies no styles, you can create your own\u003cbr/\u003e- `sidebar` uses the in-built css designed for the sidebar\u003cbr/\u003e- `body` uses the in-built css designed for the body |\n\n## Usage\n\n### Sidebar\n\nAt the bottom of your `_sidebar.md` file add the following code:\n\n```html\n\u003cfooter id=\"mb-footer\"\u003e\u003c/footer\u003e\n```\n\n### Body\n\nUnder the `\u003cdiv id=\"app\"\u003e\u003c/div\u003e` in your `index.html` file, add the following code:\n\n```html\n\u003cfooter id=\"mb-footer\"\u003e\u003c/footer\u003e\n```\n\n## Styling\n\nThe links container is sectioned into different classes for you to customise as much (or little) as you wish.\n\n```html\n\u003cfooter id=\"mb-footer\"\u003e\n  \u003cdiv class=\"footer-container\"\u003e\n    \u003cdiv class=\"footer-text\"\u003e\n      \u003cspan class=\"footer-text-copyright\"\u003e\n        Copyright © YYYY-YYYY\n      \u003c/span\u003e\n      \u003cspan class=\"footer-text-author\"\u003e\n        \u003ca target=\"_blank\" href=\"\"\u003eYour website name\u003c/a\u003e\n      \u003c/span\u003e\n    \u003c/div\u003e\n    \u003cdiv class=\"footer-link\"\u003e\n      \u003cspan class=\"footer-links-policy\"\u003e\n        \u003ca href=\"\"\u003ePolicy\u003c/a\u003e\n      \u003c/span\u003e\n      \u003cspan class=\"footer-links-terms\"\u003e\n        \u003ca href=\"\"\u003eTerms\u003c/a\u003e\n      \u003c/span\u003e\n      \u003cspan class=\"footer-links-cookies\"\u003e\n        \u003ca href=\"\"\u003eCookies\u003c/a\u003e\n      \u003c/span\u003e\n    \u003c/div\u003e\n  \u003c/div\u003e\n\u003c/footer\u003e\n```\n\n## Contributing\n\n1. Clone the repo:\u003cbr\u003e`git clone https://github.com/markbattistella/docsify-sidebarFooter.git`\n2. Create your feature branch:\u003cbr\u003e`git checkout -b my-feature`\n3. Commit your changes:\u003cbr\u003e`git commit -am 'Add some feature'`\n4. `Push` to the branch:\u003cbr\u003e`git push origin my-new-feature`\n5. Submit the `pull` request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkbattistella%2Fdocsify-sidebar-footer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkbattistella%2Fdocsify-sidebar-footer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkbattistella%2Fdocsify-sidebar-footer/lists"}