Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 49 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,52 @@
Reusable hugo theme module that powers the layer5 academy .
this modules provides the layouts , shortcodes and partials to get academy up and running
# Academy Theme

The recommended approach to use this theme is through the academy starter template .
Reusable Hugo theme module that powers the Layer5 Academy. This module provides
the layouts, shortcodes, and partials to get academy up and running.

## Getting started with this theme
## Getting Started

The recommended approach to use this theme is through the academy starter template .
The recommended approach to use this theme is through the
[academy starter template](https://github.com/layer5io/academy-example).

For comprehensive documentation, visit the
[official Academy documentation](https://docs.layer5.io/cloud/academy/).

## Content Structure

The Academy uses the following content hierarchy:

### Learning Path → Course → Module

In addition to this core structure, the following content types are available:

- **Lab** - Hands-on practical exercises
- **Challenge** - Skill assessment challenges
- **Test** - Knowledge assessments (test, optional-test,
final-test)
- **Certification** - Certification programs

## Important Notes

⚠️ **Deprecated Features**

- The `usestatic` shortcode is deprecated and should not be used in new
content.

## Contributor Guide and Resources

- 📚 [Instructions for contributing to academy-example][contrib]
- Academy-template [documentation][docs], [example][example], and
[theme][theme]
- 🎨 Wireframes and [designs for Layer5 site][figma] in Figma
([open invite][figma-invite])
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum][forum] and
[Layer5 Community Slack][slack]

[contrib]: https://github.com/layer5io/academy-example/blob/master/CONTRIBUTING.md
[docs]: https://docs.layer5.io/cloud/academy/
[example]: https://github.com/layer5io/academy-example/
[theme]: https://github.com/layer5io/academy-theme/
[figma]: https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs
[figma-invite]: https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9
[forum]: https://discuss.layer5.io
[slack]: http://slack.layer5.io