Getting Started

Requirements

To be able to edit or contribute into the Telerik UI for ASP.NET AJAX documentation you should:

1. have a git tool of your choice, so to clone, pull and push changes (e.g., GitBash, GitHub for Windows, SourceTree, etc.);
2. install Ruby and the Ruby DevKit (make sure the installation instructions for the DevKit are followed properly);
3. install the Bundler gem for Ruby.

Running Locally

Once the above requirements are fulfilled, you can generate a static web site from the Telerik UI for ASP.NET AJAX documentation's source code and browse it locally by using the following commands:

Note: Step 1 and 2 are needed only for the first time you run the local documentation. If Jekyll server has stopped—re-run it by using the Jekyll serve command.

1. Clone the repository git clone [email protected]:telerik/ajax-docs.git;

2. Run bundle install;

3. Edit _config.yml file with the desired host and port properties:

    ## The application virtual path
    host: "localhost"
    port: "8080"
    baseurl: "/aspnet-ajax"
   

4. Modify _plugins/slug.rb like below:

    11: page.url
    12: ## page.url.sub('.html', '')
   

5. Run jekyll serve

6. Open "http://[host]:[port]/aspnet-ajax/introduction.html" in your browser

   [host] and [port] can be additionally configured in the _config.yml file. By default, these properties should be configured with localhost on port 8080, e.g., http://localhost:8080/aspnet-ajax/introduction.html.

Editing

The content files are written in Markdown, based on the specification followed for Jekyll. You can read more about it in daringfireball.net/projects/markdown/.

Some elements, like notes, captions, tabbed code blocks, etc., are rendered via custom Jekyll plugins. Exact specification how to use them is available in Markdown Syntax.

Important: Always pull with re-base git pull --rebase origin master, before you push commits to the remote git push origin master.