{"id":13659189,"url":"https://github.com/marcells/bloggy-summary","last_synced_at":"2025-03-15T12:25:47.281Z","repository":{"id":16795197,"uuid":"19553837","full_name":"marcells/bloggy-summary","owner":"marcells","description":"A summary generator for blog posts in bloggy, a small and lightweight node.js blog engine.","archived":false,"fork":false,"pushed_at":"2016-01-21T23:57:47.000Z","size":5,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-22T02:47:31.274Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"Dasfaust/GlobalMarket","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marcells.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-07T23:29:34.000Z","updated_at":"2016-01-21T23:57:49.000Z","dependencies_parsed_at":"2022-07-25T05:46:07.691Z","dependency_job_id":null,"html_url":"https://github.com/marcells/bloggy-summary","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcells%2Fbloggy-summary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcells%2Fbloggy-summary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcells%2Fbloggy-summary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcells%2Fbloggy-summary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcells","download_url":"https://codeload.github.com/marcells/bloggy-summary/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243728439,"owners_count":20338256,"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":[],"created_at":"2024-08-02T05:01:06.029Z","updated_at":"2025-03-15T12:25:47.261Z","avatar_url":"https://github.com/marcells.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# bloggy-summary\n\n\u003e A summary generator for blog posts in bloggy, a small and lightweight blog engine for node.js.\n\n## Quickstart\n\nThat's everything you need. Just call the `engine.extendWith()` function of the bloggy engine. But please ensure to register bloggy-summary with `extendWith()` __after__ you've registerd a rendering engine like `bloggy-marked`.\n\n```Javascript\nvar engine = require('bloggy')();\n\nengine.extendWith(require('bloggy-summary'));\n```\n\nAfter the content of a blog entry is read, it has to new fields.\n- `summary` contains the html encoded summary up to the defined maximum length (see below)\n- `metaDescription` contains a text-only representation (\" is replaced with ') up to a length of about 180 characters. This information can be used to fill the `\u003cmeta name=\"description\" content=\".......\"\u003e` tag.\n\n## Additional options\n\nYou're able to change the following settings.\n\n```Javascript\nvar engine = require('bloggy')(),\n    bloggySummary = require('bloggy-summary');\n\n// Shown values are the default values\nbloggySummary.maxLength = 300;       // The maximum number of characters for the html-encoded, text-only summary snippet.\nbloggySummary.prefix = '\u003cp\u003e';        // Prepends some text or unencoded strings\nbloggySummary.suffix = ' ...\u003cp\u003e';    // Appends some text or unencoded strings\n\nengine.extendWith(bloggySummary);\n\n```\n\nLicense\n-------\n\nThe MIT License (MIT)\n\nCopyright (c) 2014 Marcell Spies\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcells%2Fbloggy-summary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcells%2Fbloggy-summary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcells%2Fbloggy-summary/lists"}