diff options
| author | somrat <monnaf37@gmail.com> | 2019-09-15 12:30:08 +0300 |
|---|---|---|
| committer | somrat <monnaf37@gmail.com> | 2019-09-15 12:30:08 +0300 |
| commit | 6c54d74d8583c5c1a6bee8b3a1f366ce7afe227a (patch) | |
| tree | 33b348cce8b215375a27daaff2a18dabd59cdb62 /README.md | |
| parent | d7cc8df34b58a7fd97c032178d8ffda537a6e805 (diff) | |
modified images, error building issue
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 178 |
1 files changed, 127 insertions, 51 deletions
@@ -1,72 +1,148 @@ -<div align="center"> +<p align="center"><a href="https://sourcethemes.com/academic/" target="_blank" rel="noopener"><img src="https://sourcethemes.com/academic/img/logo_200px.png" alt="Academic logo"></a></p> -# [Academia Hugo](https://themefisher.com/hugo-themes/) +# [Academic](https://sourcethemes.com/academic/): the website builder for [Hugo](https://gohugo.io) -[](https://github.com/themefisher/academia-hugo/stargazers) -[](https://github.com/themefisher/academia-hugo/issues) -[]() -[](https://github.com/themefisher/academia-hugo/network) - +### The Page Builder to Easily Create Professional Websites :pencil2: :newspaper: :rocket: -<img src="https://user-images.githubusercontent.com/37659754/60657095-823ce500-9e72-11e9-9c97-7b2012dbb234.gif" alt="screenshot" width="100%"> +**Create a free website with Academic using Markdown, Jupyter, or RStudio. Choose a beautiful color theme and build anything with the Page Builder - over 40 _widgets_, _themes_, and _language packs_ included!** -</div> -Create a free website with Academia using Markdown, Jupyter, or RStudio. Choose a beautiful color theme and build anything with the Page Builder - over 40 widgets, themes, and language packs included! +[Check out the latest **demo**](https://academic-demo.netlify.com/) of what you'll get in less than 10 minutes, or [view the **showcase**](https://sourcethemes.com/academic/#expo) of personal, project, and business sites. -** This theme is actually forked from [Academic](https://github.com/gcushen/hugo-academic) theme.** -** Images are only demonstration purpose, please don't use them.** -## Table of Contents +- 👉 [**Get Started**](https://sourcethemes.com/academic/docs/install/) +- 📚 [View the **documentation**](https://sourcethemes.com/academic/docs/) +- 💬 [**Ask a question** on the forum](https://discourse.gohugo.io) +- 👥 [Chat with the **community**](https://spectrum.chat/academic) +- 🐦 Twitter: [@source_themes](https://twitter.com/source_themes) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithAcademic](https://twitter.com/search?q=%23MadeWithAcademic&src=typd) +- 💡 [Request a **feature** or report a **bug**](https://github.com/gcushen/hugo-academic/issues) +- ⬆️ **Updating?** View the [Update Guide](https://sourcethemes.com/academic/docs/update/) and [Release Notes](https://sourcethemes.com/academic/updates/) +- :heart: **Support development** of Academic: + - ☕️ [**Donate a coffee**](https://paypal.me/cushen) + - 💵 [Become a backer on **Patreon**](https://www.patreon.com/cushen) + - 🖼️ [Decorate your laptop or journal with an Academic **sticker**](https://www.redbubble.com/people/neutreno/works/34387919-academic) + - 👕 [Wear the **T-shirt**](https://academic.threadless.com/) + - :woman_technologist: [**Contribute**](https://sourcethemes.com/academic/docs/contribute/) -- [Demo](#demo) -- [Installation](#installation) -- [Premium Features](#premium-features) -- [Reporting Issues](#reporting-issues) -- [Technical Support or Questions](#technical-support-or-questions) -- [Licensing](#licensing) -- [More Hugo Themes](https://themefisher.com/hugo-themes/) +[](https://github.com/gcushen/hugo-academic/) -## Demo +**Key features:** -[Live Demo](https://themes.gohugo.io/theme/academia-hugo/). +- **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 +- **One-Click Deployment** - No servers. No databases. Only files. -## Installation +## Color Themes -Navigate to your themes folder in your Hugo site and use the following commands: +Academic comes with **day (light) and night (dark) mode** built-in. Click the sun/moon icon in the top right of the [Demo](https://academic-demo.netlify.com/) to see it in action! +Choose a stunning color and font theme for your site. Themes are fully customizable and include: + +| `default` | `ocean` | `forest` | `dark` | +| --- | --- | --- | --- | +|  |  |  |  | + +| `apogee` | `1950s` | `coffee` | `strawberry` | +| --- | --- | --- | --- | +|  |  |  |  | + +[Browse more themes...](https://sourcethemes.com/academic/themes/) + +## Ecosystem + +* **[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 + +## Install + +You can choose from one of the following four methods to install: + +* **one-click install using your web browser (recommended)** +* install on your computer using Git with the Command Prompt/Terminal app +* install on your computer by downloading the ZIP files +* install on your computer with RStudio + +### Install with web browser + +[Install Academic with Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/sourcethemes/academic-kickstart) + * One-click install of Academic creates an `academic-kickstart` repository in your GitHub or GitLab account + * Netlify will provide you with a customizable URL to access your new site, [or get your own domain](https://sourcethemes.com/academic/docs/domain/) + * Shortly after editing content in your repository, your site will automatically update + * Optionally, to edit your site in a [Markdown editor](https://www.typora.io) on your computer, perform the steps in the [*Install with Git*](#install-with-git) section below + +### Install with Git + +Prerequisites: + +* [Download and install Git](https://git-scm.com/downloads) +* [Download and install Hugo Extended v0.55.6+](https://gohugo.io/getting-started/installing/#quick-install) + +Install: + +1. [Fork](https://github.com/sourcethemes/academic-kickstart#fork-destination-box) the *Academic Kickstart* repository to create a new website + * If you already created your site with **Netlify**, then skip this step +2. Clone your fork to your computer with Git, replacing `sourcethemes` in the command below with your GitHub username: + + ```bash + git clone https://github.com/sourcethemes/academic-kickstart.git My_Website + ``` + +3. Initialize the theme: + + ```bash + cd My_Website + git submodule update --init --recursive + ``` + +### Install with ZIP + +Prerequisites: + +* [Download and install Hugo Extended v0.55.6+](https://gohugo.io/getting-started/installing/#quick-install) + +Install: + +1. [Download](https://github.com/sourcethemes/academic-kickstart/archive/master.zip) and extract *Academic Kickstart* +2. [Download](https://github.com/gcushen/hugo-academic/archive/master.zip) and extract the *Academic theme* files from the `hugo-academic-master` folder to the `themes/academic/` folder in *Academic Kickstart* + +### Install with RStudio + +[Install Academic with RStudio](https://sourcethemes.com/academic/docs/install/#install-with-rstudio) + +## Demo content + +For inspiration, refer to the [Markdown content](https://github.com/gcushen/hugo-academic/tree/master/exampleSite) which powers the [Demo](https://academic-demo.netlify.com/). + +If you wish to initialise your site with the demo content, copy the contents of the `themes/academic/exampleSite/` folder to your website root folder, overwriting existing files if necessary. The `exampleSite` folder contains an example config file and content to help you get started. The following command can be used to accomplish this: + +```bash +cp -av themes/academic/exampleSite/* . ``` -$ mkdir themes -$ cd themes -$ git clone https://github.com:themefisher/academia-hugo.git -``` -* **Page builder** Create anything with widgets and elements -* **Edit any type of content** Blog posts, publications, talks, slides, projects, and more! -* **Create content** in Markdown, Jupyter, or RStudio. -* **Display Code and Math** Code highlighting and LaTeX math supported -* **SEO Friendly** All codes are seo friendly. There is fields to put meta data and other seo parameters in every pages. -* **Multi Language** We have multi language support in premium version . Right now there is two language include in the theme , those are French and English. If you need more we can help you out. -* **Google Analytics** You can add you google analytics code in theme config file to connect with your google anlytics account . -* **Support** With premium version you will get one month priority support. -## Reporting Issues +## Get Started -We use GitHub Issues as the official bug tracker for the academia Template. Please Search [existing issues](https://github.com/themefisher/academia-hugo/issues). It’s possible someone has already reported the same problem. -If your problem or idea is not addressed yet, [open a new issue](https://github.com/themefisher/academia-hugo/issues) +[View the guide to Personalize and Deploy your new site](https://sourcethemes.com/academic/docs/get-started/). -## Technical Support or Questions +## Updating -If you have questions or need help integrating the product please [contact us](mailto:themefisher@gmail.com) instead of opening an issue. +[View the Update Guide](https://sourcethemes.com/academic/docs/update/). -## Licensing +Feel free to *star* the project on [Github](https://github.com/gcushen/hugo-academic/) and follow [@source_themes](https://twitter.com/source_themes) on Twitter to help keep track of [updates](https://sourcethemes.com/academic/updates). -- Licensed under MIT (https://github.com/themefisher/academia-hugo/blob/master/LICENSE) +## License -## Hire Us -We are available for Hiring of your next HUGO project. Drop Us a mail [themefisher@gmail.com](mailto:themefisher@gmail.com) +Copyright 2016-present [George Cushen](https://georgecushen.com). -## Premium Themes +Released under the [MIT](https://github.com/gcushen/hugo-academic/blob/master/LICENSE.md) license. -| [](https://themefisher.com/products/biztrox-hugo-template/) | [](https://themefisher.com/products/bexer-hugo-theme/) | [](https://themefisher.com/products/small-apps-hugo-app-landing-theme/) | -|:---:|:---:|:---:| -| **Biztrox** | **Bexer** | **Small Apps** | -| [](https://themefisher.com/products/dtox-hugo-theme/) | [](https://themefisher.com/products/agico-hugo-theme/) | [](https://themefisher.com/products/airspace-hugo/) | -| **Dtox** | **Agico** | **Airspace** |
\ No newline at end of file +[](https://github.com/igrigorik/ga-beacon) |