From c297daed8a7b1a0df7c5c63ca7d8db5e2314bd8f Mon Sep 17 00:00:00 2001 From: mitchell <70453897+667e-11@users.noreply.github.com> Date: Sun, 12 Jan 2014 23:44:33 -0500 Subject: New home page along with some documentation content and layout changes. --- CHANGELOG.md | 6 +- README.md | 3 +- doc/.header.md | 3 +- doc/images/feed.png | Bin 0 -> 1737 bytes doc/images/header.png | Bin 0 -> 104022 bytes doc/images/logo_large.png | Bin 0 -> 30923 bytes doc/index.html | 272 ++++++++++++++++++++++++++++++++++++++++++++++ doc/markdowndoc.lua | 1 + src/Makefile | 27 +++-- 9 files changed, 298 insertions(+), 14 deletions(-) create mode 100644 doc/images/feed.png create mode 100644 doc/images/header.png create mode 100644 doc/images/logo_large.png create mode 100644 doc/index.html diff --git a/CHANGELOG.md b/CHANGELOG.md index 0c8adbb7..85ce333b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,11 +2,10 @@ [Atom Feed][] -**Please consider making a [donation][] or purchasing the [book][] to help fund -Textadept's continuous development. It really helps.** +**Please [donate][] or purchase the [book][] to fund continuous development.** [Atom Feed]: feed -[donation]: http://gum.co/textadept +[donate]: http://gum.co/textadept [book]: MEDIA.html#Book ## 7.2 alpha (01 Jan 2014) @@ -40,6 +39,7 @@ Changes: * Renamed "hypertext" lexer and its corresponding module to "html". * Added configurable tab context menus via [`textadept.menu.set_contextmenus()`][]. +* New GUI theme for Mac OSX. * [Experimental] Merged separate lexer states into Textadept's Lua state. * Updated to [Lua][] 5.2.3. * Updated to [Scintilla][] 3.3.7. diff --git a/README.md b/README.md index 68acf217..6d48c3bd 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,7 @@ The terminal version of Textadept requires only an implementation of curses like ## Download -**Please consider making a [donation][] or purchasing the [book][] to help fund -Textadept's continuous development. It really helps.** +**Please [donate][] or purchase the [book][] to fund continuous development.** Download Textadept from the project's [download page][] or from these quick links: diff --git a/doc/.header.md b/doc/.header.md index 42c1289c..4b5fd35e 100644 --- a/doc/.header.md +++ b/doc/.header.md @@ -3,7 +3,8 @@ * [Home](http://foicica.com/textadept) | * [Download](http://foicica.com/textadept/download) | * [Book](http://foicica.com/textadept/MEDIA.html#book) | -* [Lua API](http://foicica.com/textadept/api) | +* [Manual](http://foicica.com/textadept/01_Introduction.html) | +* [API](http://foicica.com/textadept/api) | * [Source](http://foicica.com/hg/textadept) | * [Language Modules](http://foicica.com/hg) | * [Stats](http://foicica.com/textadept/stats) | diff --git a/doc/images/feed.png b/doc/images/feed.png new file mode 100644 index 00000000..d64c669c Binary files /dev/null and b/doc/images/feed.png differ diff --git a/doc/images/header.png b/doc/images/header.png new file mode 100644 index 00000000..aaf5b55d Binary files /dev/null and b/doc/images/header.png differ diff --git a/doc/images/logo_large.png b/doc/images/logo_large.png new file mode 100644 index 00000000..899dc4d9 Binary files /dev/null and b/doc/images/logo_large.png differ diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 00000000..18064afc --- /dev/null +++ b/doc/index.html @@ -0,0 +1,272 @@ + + + + Textadept + + + + + +
+ + + + +
+

Support

+ + +

Quick Reference

+

+ + Cover + +

+
+ +
+

+ Textadept Logo +

+

+ Please donate or purchase the + quick reference to fund continuous + development. +

+ +

Features

+ +
+

Fast and Minimalist

+

+ Textadept’s user interface is sleek and simple. Relentlessly + optimized for speed and minimalism over the years, the editor + consists of less than 2000 lines of C code and less than 4000 lines + of Lua code. +

+

+ Textadept +

+
+
+

Cross Platform

+

+ Textadept runs on Windows, Mac OSX, Linux, and BSD. It also has a + terminal version, which is ideal for work on remote machines. +

+

+ Linux   + Mac OSX +

+

+ Win32   + curses +

+
+
+
+

Remarkably Extensible

+

+ Textadept is an ideal editor for programmers who want endless + extensibility without sacrificing speed or succumbing to code bloat + and featuritis. The editor gives you complete control over the + entire application using the Lua programming language. Everything + from moving the caret to changing menus and key commands on-the-fly + to handling core events is possible. Its potential is vast. +

+
+
+

Multiple Language Support

+

+ Being a programmer’s editor, Textadept excels at editing source + code. It understands the syntax and structure of more than 80 + different programming languages and recognizes hundreds of file + types. Textadept uses this knowledge to make viewing and editing + code faster and easier. It can also compile and run simple source + files. +

+
+
+
+

Unlimited Split Views

+

+ The graphical version of Textadept supports unlimited view splitting + both vertically and horizontally. +

+

+ Split Views +

+
+
+

Customizable Themes

+

+ Textadept uses themes to customize its look and feel. It comes with + built-in light, dark, and terminal themes. +

+

+ Light Theme   + Dark Theme +

+

+ Term Theme +

+
+
+
+

Code Autocompletion

+

+ Not only can Textadept autocomplete words in files, but it can also + autocomplete symbols for programming languages and display API + documentation. +

+

+ Adeptsense Lua  + Adeptsense Lua String +

+
+
+

Keyboard Driven

+

+ Textadept is entirely keyboard driven. The editor defines key + bindings for nearly every action. You can easily reassign existing + bindings or create new ones. Keys may be chained together or grouped + into language-specific keys or key modes. +

+

Self Contained

+

+ Textadept’s binary packages are self-contained and need not be + installed. No administrator privilages are required either. +

+
+ +

Learn More

+ +
+

Comprehensive Manual

+

+ Textadept comes with a comprehensive user manual in the + application’s doc/ directory. This manual is also available + online. It covers all of + Textadept’s main features, including installation, usage, + configuration, theming, scripting, and compilation. +

+
+
+

Exhaustive API Documentation

+

+ Since Textadept is entirely scriptable with Lua, its API is heavily + documented. This documentation is located in the doc/api/ + directory (also available online), and is the + ultimate resource on scripting Textadept. (The editor’s Lua + internals also provide abundant scripting examples.) +

+
+
+
+

Quick Reference

+

+ + Cover2 + +

+

+ This reference contains a wealth of knowledge on how to script and + configure Textadept using Lua. It groups the editor’s rich API into + a series of tasks in a convenient and easy-to-use manner. It serves + as the perfect complement to Textadept’s Manual and API + documentation. +

+
+
+

Try It Yourself

+

+ Learn even more about Textadept by downloading and trying it out + yourself. If you’re not completely satisfied, contact us on the + mailing list or e-mail me + personally (mitchell.att.foicica.com). You may also fork the project + or submit patches. Textadept is 100% open source. +

+

+ + Download + +

+
+ +
+

+ FAQ · + Media · + Credits +

+ +
+
+

+ + *Warning: nightly builds are untested, may have bugs, and are + the absolute cutting-edge versions of Textadept. Do not use them in + production, but for testing purposes only. +

+
+ + +
+ + diff --git a/doc/markdowndoc.lua b/doc/markdowndoc.lua index e8947784..2ee19ac0 100644 --- a/doc/markdowndoc.lua +++ b/doc/markdowndoc.lua @@ -170,6 +170,7 @@ function M.start(doc) local p = io_popen('markdown "'..navfile..'"') local nav = p:read('*all') p:close() + os.remove(navfile) -- Write index.html. template.nav = nav diff --git a/src/Makefile b/src/Makefile index 2146947b..10a9f35a 100644 --- a/src/Makefile +++ b/src/Makefile @@ -136,6 +136,7 @@ ifneq (, $(or $(findstring Linux, $(kernel)), $(findstring BSD, $(kernel)))) # # luadoc = luadoc endif +bombay = ../doc/bombay # No debugging unless DEBUG=1. ifdef DEBUG @@ -147,8 +148,7 @@ endif sci_flags = -pedantic -Os $(plat_flag) -DSCI_LEXER -DNDEBUG \ -DG_THREADS_IMPL_NONE -Iscintilla/include -Iscintilla/src \ - -Iscintilla/lexlib -Wall -Wno-missing-braces -Wno-char-subscripts \ - -Wno-long-long + -Iscintilla/lexlib -Wall -Wno-char-subscripts sci_objs = AutoComplete.o CallTip.o CaseConvert.o CaseFolder.o Catalogue.o \ CellBuffer.o CharClassify.o ContractionState.o Decoration.o \ @@ -205,7 +205,7 @@ osx-curses: textadept-curses textadeptjit-curses # Dependencies. base_deps = scintilla scintilla/term scintillua lua lualibs luajit gtdialog \ - cdk ../doc/bombay + cdk $(bombay) deps: $(base_deps) termkey win32-deps: $(base_deps) win32gtk win32curses osx-deps: $(base_deps) gtkosx termkey @@ -324,9 +324,11 @@ clean: # Documentation. -doc: manual luadoc adeptsense -manual: ../doc/*.md ../*.md | ../doc/bombay - $| -d ../doc -t ../doc --title Textadept --navtitle Manual $^ +doc: rootdoc manual luadoc adeptsense +rootdoc: ../*.md + $(bombay) -d ../doc -t ../doc --title Textadept --navtitle '' $^ +manual: ../doc/*.md + $(bombay) -d ../doc -t ../doc --title Textadept --navtitle Manual $^ luadoc: ../modules ../core ../lexers cd ../doc && $(luadoc) -d . -t . --doclet markdowndoc $^/lexer.lua adeptsense: ../modules ../core ../lexers @@ -418,7 +420,7 @@ osx-app: ../textadept ../textadeptjit ../textadept-curses \ # External dependencies. -scintilla_tgz = scintilla337.tgz?download +scintilla_tgz = scintilla337.tgz scinterm_zip = scinterm.zip scintillua_zip = scintillua.zip lua_tgz = lua-5.2.3.tar.gz @@ -437,6 +439,7 @@ win32curses_zip = win32curses.zip pdcurses_zip = download gtkosx_zip = gtkosx-2.24.16.zip bombay_zip = bombay.zip +cloc = cloc-1.60.pl $(scintilla_tgz): ; wget "http://prdownloads.sourceforge.net/scintilla/$@" -O $@ scintilla: scintilla.patch | $(scintilla_tgz) @@ -507,6 +510,14 @@ win32curses: | $(win32curses_zip) $(pdcurses_zip) $(gtkosx_zip): ; wget "http://foicica.com/textadept/download/$@" gtkosx: | $(gtkosx_zip) ; mkdir $@ && unzip -d $@ $| && mv $@/*/* $@ $(bombay_zip): ; wget "http://foicica.com/hg/bombay/archive/tip.zip" -O $@ -../doc/bombay: | $(bombay_zip) +$(bombay): | $(bombay_zip) mkdir $(notdir $@) && unzip -d $(notdir $@) $| && \ mv $(notdir $@)/*/* $(dir $@) +$(cloc): ; wget "http://prdownloads.sourceforge.net/cloc/$@" -O $@ + +# Count lines of code. + +sources = ../core ../modules/ansi_c ../modules/lua ../modules/textadept \ + ../themes textadept.c Makefile ../init.lua ../properties.lua +count: $(cloc) + perl $< $(sources) --not-match-f=adeptsensedoc.lua -- cgit v1.2.3