{"id":19316219,"url":"https://github.com/userfrosting/learn","last_synced_at":"2025-06-15T18:06:58.357Z","repository":{"id":11699448,"uuid":"70296428","full_name":"userfrosting/learn","owner":"userfrosting","description":"Documentation and guide for UserFrosting","archived":false,"fork":false,"pushed_at":"2025-03-31T11:50:47.000Z","size":18423,"stargazers_count":14,"open_issues_count":0,"forks_count":40,"subscribers_count":8,"default_branch":"5.1","last_synced_at":"2025-04-08T22:02:00.107Z","etag":null,"topics":["userfrosting","userfrosting-documentation"],"latest_commit_sha":null,"homepage":"https://learn.userfrosting.com","language":"JavaScript","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/userfrosting.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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},"funding":{"github":null,"patreon":null,"open_collective":"userfrosting","ko_fi":"lcharette","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2016-10-08T02:08:07.000Z","updated_at":"2025-03-31T11:50:32.000Z","dependencies_parsed_at":"2024-07-10T20:39:24.834Z","dependency_job_id":"19b8d582-165c-46c0-b9f9-04b7c8c2e67b","html_url":"https://github.com/userfrosting/learn","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/userfrosting%2Flearn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/userfrosting%2Flearn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/userfrosting%2Flearn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/userfrosting%2Flearn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/userfrosting","download_url":"https://codeload.github.com/userfrosting/learn/tar.gz/refs/heads/5.1","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250277494,"owners_count":21404048,"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":["userfrosting","userfrosting-documentation"],"created_at":"2024-11-10T01:10:31.784Z","updated_at":"2025-04-22T16:33:17.455Z","avatar_url":"https://github.com/userfrosting.png","language":"JavaScript","funding_links":["https://opencollective.com/userfrosting","https://ko-fi.com/lcharette"],"categories":[],"sub_categories":[],"readme":"# UserFrosting Documentation\n\nhttps://learn.userfrosting.com\n\nThis is the repository for the documentation for UserFrosting 5. It is built with the flat-file CMS [Grav](http://getgrav.org), using their [RTFM skeleton](https://github.com/getgrav/grav-skeleton-rtfm-site#rtfm-skeleton).\n\n## Getting started\n\nThis site is built using [Grav](https://learn.getgrav.org/) CMS, which like UserFrosting v4 has combined framework and project skeleton code. To permit easier content management, this repository only includes Grav's `user/` directory, which is where all of our custom content, themes, and assets live. See [Grav Development with GitHub - Part 2](https://getgrav.org/blog/developing-with-github-part-2) for more on this approach.\n\n## Syntax\n\nGrav uses Markdown to format text. Additionally, this site uses the [Grav Shortcode Core Plugin](https://github.com/getgrav/grav-plugin-shortcode-core) plugin to enable more non-standard Markdown code, like `[notice]`.\n\nSee [Grav Shortcode Plugin](https://github.com/getgrav/grav-plugin-shortcode-core?tab=readme-ov-file#available-shortcodes) for a list of available markdown code.\n\n## Installation\n\n### Complete Local Installation\n\n**This branch contains the documentation associated with the branch of the same name from [`userfrosting/userfrosting`](https://github.com/userfrosting/UserFrosting).** [See Website Installation Guide](https://github.com/userfrosting/learn/blob/website/README.md#getting-started) to install a complete instance of the docs with all versions available. \n\nTo install a single copy of this branch (without multiple versions available), multiple installation methods are available:\n\n1. [Local Installation](#local-installation)\n2. [Docker](#docker)\n\n### Local Installation\n\nThis guide does not cover setting up the webserver and assumes your host is already setup.\n\n1. Install Grav and replace the `user` directory with this repository\n   ```\n   git clone https://github.com/getgrav/grav.git userfrosting-learn\n   cd userfrosting-learn\n   rm -r user\n   git clone https://github.com/userfrosting/learn.git user\n   ```\n\n2. Install Grav\n   ```\n   bin/grav install\n   ```\n\nWhen you're done, the directory structure should look like this:\n\n```\nhtdocs/\n└── userfrosting-learn/\n   ├── assets/\n   ├── ...\n   ├── user/\n       ├── .git\n       ├── accounts/\n       ├── assets/\n       ├── config/\n       └── ...\n   └── ...\n```\n\n### Docker\n\n1. Clone repo\n   ```\n   git clone https://github.com/userfrosting/learn.git userfrosting-learn\n   cd userfrosting-learn\n   ```\n\n2. Build Grav container\n   ```\n   docker build -t learn:latest .\n   ```\n\n3. Start Grav container\n   ```\n   docker run -d --rm --name=learn -p 8888:80 -v \"$(pwd):/var/www/grav/user\" learn:latest\n   ```\n\nIt will take a couples of second for the site to be up and running while the base Grav installation is done. Once this is complete, you can access the documentation at [http://localhost:8888/](http://localhost:8888/).\n\nTo stop the container:\n\n```bash\ndocker stop learn\n```\n\nTo access Grav command line utility or gpm, you can use :\n\n```bash\ndocker exec -it learn bash\nchmod +x bin/gpm # This is only needed if permissions are acting up\nbin/grav install\n```\n\n## Credits\n\nFavicons were generated with https://realfavicongenerator.net/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuserfrosting%2Flearn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuserfrosting%2Flearn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuserfrosting%2Flearn/lists"}