{"id":19714049,"url":"https://github.com/grails/grails-static-website","last_synced_at":"2025-03-14T07:07:22.962Z","repository":{"id":25809563,"uuid":"29248556","full_name":"grails/grails-static-website","owner":"grails","description":"Static version of the website","archived":false,"fork":false,"pushed_at":"2024-10-24T04:06:11.000Z","size":73622,"stargazers_count":24,"open_issues_count":3,"forks_count":87,"subscribers_count":17,"default_branch":"master","last_synced_at":"2024-10-24T04:32:07.382Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Groovy","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"mzur/kirby-uniform","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grails.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2015-01-14T14:41:50.000Z","updated_at":"2024-10-16T20:40:28.000Z","dependencies_parsed_at":"2024-01-23T09:56:13.007Z","dependency_job_id":"4e98f5fd-4ac0-4f9b-8f45-5e66beab3b40","html_url":"https://github.com/grails/grails-static-website","commit_stats":{"total_commits":1002,"total_committers":66,"mean_commits":"15.181818181818182","dds":0.7325349301397206,"last_synced_commit":"5ce5a3273f6312b0ab68423cc193eb7f64e77029"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grails%2Fgrails-static-website","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grails%2Fgrails-static-website/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grails%2Fgrails-static-website/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grails%2Fgrails-static-website/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grails","download_url":"https://codeload.github.com/grails/grails-static-website/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243268642,"owners_count":20263900,"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-11-11T22:28:45.700Z","updated_at":"2025-03-14T07:07:22.931Z","avatar_url":"https://github.com/grails.png","language":"Groovy","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Grails Website\n\n[![Build Status](https://github.com/grails/grails-static-website/workflows/Publish/badge.svg)](https://github.com/grails/grails-static-website/actions)\n\nThis project builds the Grails website. A static website build with [Gradle](https://gradle.org). It uses a Gradle Plugin whose sources can be found at `buildSrc`.\n\nGradle tasks use `grails` group.\n\nYou can get more info by running:\n\n```\n  % ./gradlew tasks --group=grails\n\n \u003e Task :tasks\n\n ------------------------------------------------------------\n Tasks runnable from root project\n ------------------------------------------------------------\n\n Grails tasks\n ------------\n buildGuides - Build guides website - generates guides pages, copies assets and generates a sitemap\n copyAssets - Copies css, js, fonts and images from the assets folder to the dist folder\n genDocs - Generates documentation HTML page - build/temp/documentation.html\n genFaq - Generates FAQ HTML - build/temp/faq.html\n genGuides - Generates guides home, tags and categories HTML pages - build/temp/index.html\n genProfiles - Generates profiles HTML page - build/temp/profiles.html\n genSitemap - Generates build/dist/sitemap.xml with every page in the site\n renderBlog - Renders Markdown posts (posts/*.md) into HTML pages (dist/blog/*.html). It generates tag pages. Generates RSS feed. Posts with future dates are not generated.\n renderSite - Build Grails website - generates pages with HTML entries in pages and build/temp, renders blog and RSS feed, copies assets and generates a sitemap\n\n To see all tasks and more detail, run gradlew tasks --all\n\n To see more detail about a task, run gradlew help --task \u003ctask\u003e\n\n BUILD SUCCESSFUL in 558ms\n 1 actionable task: 1 executed\n```\n\n## Generating the MAIN site\n\n[https://grails.org](https://grails.org)\n\n```bash\n./gradlew build --console=plain\n```\n\nThe output can be found in the `build/dist` directory.\n\n## Generating the GUIDES site\n\n[https://guides.grails.org](https://guides.grails.org)\n\n```bash\n./gradlew buildGuide --console=plain\n\n```\nThe output can be found in the `build/dist` directory.\n\n## Running the website locally\n\nThe easiest way to work locally is to generate the site and setup your Webserver to serve build/dist.\n\nFor example with [MAMP](https://www.mamp.info/en/mamp/):\n\n![](docs/mamp.png)\n\nYou can also use Python to serve the directory:\n\n```\npython3 -m http.server 8080 --directory build/dist\n```\n\n## Blog Posts\n\n### Posts Location\n\nWrite blog posts in markdown at `posts` folder.\n\n### Blog post Metadata\n\nA post supports metadata at the beginning of the document. You can use it store information (title, description, publication date) about your blog posts.\n\nMetadata must be separated from the rest of the document by three dashes.\n\nYou can use the metadata in the text by putting it in brackets adding a % sign.\n\nA typical blog post will look like:\n\n```markdown\n---\ntitle: Deploying Grails 3.1 Applications to JBoss 6.4 EAP\ndate: May 26, 2016\ndescription: Learn necessary configuration differences to deploy Grails 3.1 applications to JBoss 6.4 EAP\nauthor: Graeme Rocher\nimage: 2016-05-26.jpg\n---\n\n# [%title]\n\n[%author]\n\n[%date]\n\nWe had [previously](https://grails.io/post/142674392718/deploying-grails-3-to-wildfly-10) described how to deploy Grails 3.1 applications to WildFly 10, which is where all of the \"cutting edge\" work happens in the JBoss world.\n\nThe process to deploy Grails 3.1 applications to JBoss 6.4 EAP is largely similar, with some minor configuration differences.\n```\n\n#### Text Expander snippets\n\nIf you write often to Grails's blog, we recommend you to create a [Text Expander](https://textexpander.com) snippet:\n\n ![](docs/textexpander.png)\n\n\n#### Title Metadata\n\n`title` tag is used as the window title, the card title, blog post main header and also in twitter cards.\n\n#### Description Metadata\n\nDescription metadata is used as HTML meta description tag, and in twitter cards.\n\n#### Date Metadata\n\nDate is used to for publication date. It is used to order to blog posts. It is displayed in the UI and in the RSS feed.\n\nDate can be expressed in `MMM d, yyyy`\n\n```markdown\n---\n...\n..\n.\ndate: April 9, 2020\n---\n\n```\n\nor `MMM d, yyyy HH:mm`\n\n```markdown\n---\n...\n..\n.\ndate: April 9, 2020 09:00\n---\n\n```\n\n**To Schedule tasks use a date in the future. Github Action runs daily and will publish scheduled posts.**\n\n#### Blog post background\n\nFor Blog post background images usage image metadata.\n\n```markdown\n---\n...\n..\n.\nimage: 2018-05-23.jpg\n---\n```\n\nPlace the images at `assets/bgimages`\n\n![](docs/blogimages.png)\n\n### Tags\n\nTo add tags just preffix them with `#`:\n\nExample:\n\n```markdown\nTags: #angular\n```\n\n**Webinars on-demand recordings should be tagged with `webinar`**\n\nRelease announcements should be tagged with `release`.\n\nCheck the [list of tags](https://grails.org/blog/index.html) and try to reuse them.\n\n#### Code Highlighting\n\nIf your blog post, contains code samples add the following metadata:\n\n```markdown\n---\n...\n..\n.\nCSS: [%url]/stylesheets/prism.css\nJAVASCRIPT: [%url]/javascripts/prism.js\n---\n\n# [%title]\n\n```\n\n#### Video\n\nUse the `video` metadata to embed a Video.\n\nCurrently, the plugin supports youtube videos. Use a link which starts with `https://www.youtube.com/watch?v=` such as `https://www.youtube.com/watch?v=RtjSqRZ_md4`\n\nExample:\n\n```markdown\n---\ntitle: JSON Views\ndate: April 1, 2016\ndescription: Jeff Scott Brown uses music examples to probe JSON views.\nauthor: Jeff Scott Brown\nimage: 2016-04-01-2.jpg\nvideo: https://www.youtube.com/watch?v=XnRNfDGkBVg\n---\n\n# [%title]\n\n[%author]\n\n[%date]\n\nTags:\n\n[%description]\n```\n\n## Assets (Fonts, Stylesheets, Images, Javascripts)\n\nAssets used in the website can be found under `assets`.\n\n## What to change when a new release is published.\n\nPlease, modify `conf/releases.yml`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrails%2Fgrails-static-website","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrails%2Fgrails-static-website","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrails%2Fgrails-static-website/lists"}