mirror of
https://github.com/gcushen/hugo-academic.git
synced 2025-07-26 03:00:50 +02:00
docs: edit features and update guide
This commit is contained in:
parent
a62c6bf01f
commit
a554d5dc10
1 changed files with 16 additions and 18 deletions
34
README.md
34
README.md
|
@ -20,13 +20,20 @@ Follow our easy [step by step guide](https://sourcethemes.com/academic/docs/inst
|
|||
|
||||
**Key features:**
|
||||
|
||||
- Easily manage various content including homepage, blog posts, publications, talks, slides, and projects
|
||||
- Extensible via **color themes** and **widgets/plugins**
|
||||
- Write in [Markdown](https://sourcethemes.com/academic/docs/writing-markdown-latex/) for easy formatting and code highlighting, with [LaTeX](https://en.wikibooks.org/wiki/LaTeX/Mathematics) for mathematical expressions
|
||||
- Social/academic network linking, [Google Analytics](https://analytics.google.com), and [Disqus](https://disqus.com) comments
|
||||
- Responsive and mobile friendly
|
||||
- Simple and refreshing one page design
|
||||
- Multilingual and easy to customize
|
||||
- **Page builder** - Create *anything* with [**widgets**](https://sourcethemes.com/academic/docs/page-builder/) and [**elements**](https://sourcethemes.com/academic/docs/writing-markdown-latex/)
|
||||
- **Edit any type of content** - Blog posts, publications, talks, slides, projects, and more!
|
||||
- **Create content** in [**Markdown**](https://sourcethemes.com/academic/docs/writing-markdown-latex/), [**Jupyter**](https://sourcethemes.com/academic/docs/jupyter/), or [**RStudio**](https://sourcethemes.com/academic/docs/install/#install-with-rstudio)
|
||||
- **Plugin System** - Fully customizable [**color** and **font themes**](https://sourcethemes.com/academic/themes/)
|
||||
- **Display Code and Math** - Code highlighting and [LaTeX math](https://en.wikibooks.org/wiki/LaTeX/Mathematics) supported
|
||||
- **Integrations** - [Google Analytics](https://analytics.google.com), [Disqus commenting](https://disqus.com), Maps, Contact Forms, and more!
|
||||
- **Beautiful Site** - Simple and refreshing one page design
|
||||
- **Industry-Leading SEO** - Help get your website found on search engines and social media
|
||||
- **Media Galleries** - Display your images and videos with captions in a customizable gallery
|
||||
- **Mobile Friendly** - Look amazing on every screen with a mobile friendly version of your site
|
||||
- **Multi-language** - 15+ language packs including English, 中文, and Português
|
||||
- **Multi-user** - Each author gets their own profile page
|
||||
- **Privacy Pack** - Assists with GDPR
|
||||
- **Stand Out** - Bring your site to life with animation, parallax backgrounds, and scroll effects
|
||||
|
||||
## Color Themes
|
||||
|
||||
|
@ -44,7 +51,6 @@ Academic is available in different color themes and font themes.
|
|||
|
||||
* **[Academic Admin](https://github.com/sourcethemes/academic-admin):** An admin tool to import publications from BibTeX or import assets for an offline site
|
||||
* **[Academic Scripts](https://github.com/sourcethemes/academic-scripts):** Scripts to help migrate content to new versions of Academic
|
||||
* **[Project KickstartR](https://github.com/sourcethemes/project-kickstart-r):** Create a Project, Team, or Conference **Landing Page** and **Knowledge Sharing Platform** with (R) Markdown
|
||||
|
||||
## Install
|
||||
|
||||
|
@ -103,17 +109,9 @@ Prerequisites:
|
|||
|
||||
## Updating
|
||||
|
||||
Feel free to *star* the project on [Github](https://github.com/gcushen/hugo-academic/) to help keep track of updates and check out the [release notes](https://sourcethemes.com/academic/updates) prior to updating your site.
|
||||
[View the Update Guide](https://sourcethemes.com/academic/docs/update/).
|
||||
|
||||
Before updating the framework, it is recommended to make a backup of your entire website directory (or at least your `themes/academic` directory) and record your current version number.
|
||||
|
||||
By default, Academic is installed as a Git submodule which can be updated by running the following command:
|
||||
|
||||
```bash
|
||||
git submodule update --remote --merge
|
||||
```
|
||||
|
||||
[Check out the update guide](https://sourcethemes.com/academic/docs/update/) for full instructions and alternative methods.
|
||||
Feel free to *star* the project on [Github](https://github.com/gcushen/hugo-academic/) to help keep track of [updates](https://sourcethemes.com/academic/updates).
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue